Integration Guide for Banks
[UKR] Посібник з інтеграції для банку
[UKR] Посібник з інтеграції для банку
  • General
    • 💰Загальний опис
      • Перекази між цифровізованими сутностями
        • Варіант 1. Швидке створення/видалення ідентифікаторів
        • Варіант 2. Стандартне створення/видалення ідентифікаторів (опціонально)
      • Історія версій
      • Журнал змін API
      • Глосарій
    • 🌐Загальні вимоги
    • 👉Базовий варіант впровадження
    • 📅План інтеграції
      • План інтеграції (Бізнес)
      • План інтеграції (Технічна команда)
      • Мультипідпис
    • ❗Повідомлення про помилки
  • 🛠️API МЕТОДИ
    • Автентифікація
      • Авторизація через JWT
      • Служба Аутентифікації Банку
      • JWT формат
    • Працівники
      • Призначити роль працівнику
      • Управління ролями
    • Клієнти
      • Сегмент
    • Цифровізовані сутності
    • Ідентифікатори
    • Трансфер (перерозподілення ідентифікаторів)
      • Мультипідпис для трансферів
      • Зворотні виклики
      • Категорія
    • Ліміти
    • Реконсиляція
    • [необов’язково] Відділення
      • Відділення (доступ)
      • Як додати працівника до віддлення (філії)
      • Фільтр по відділенню
      • Трансфери (Відділення)
Powered by GitBook
On this page
  1. API МЕТОДИ

Цифровізовані сутності

PreviousСегментNextІдентифікатори

Last updated 1 year ago

DCM використовує наступні типи Цифровізовані сутності:

  1. Дистрибюторський - ідентифікатор для створення/видалення цифрових ідентифікаторів

  2. Ідентифікаційний - ідентифікатор для розподілення цифрових ідентифікаторів певному Контрагенту

  3. Процесинговий - ідентифікатор для розподілу ідентифікаторів між відділеннями (філіями) одного контаргента та/або клієнтами як в межах одного контрагента, так і між різними.

  4. Клієнтський - кожен Клієнт має власний ідентифікатор зареєстрований в Прозорій Мережі та має ідентифікатор в Stellar

Примітка: сутність має один ідентифікатор (накшталт валюти).

Сутність ідентифікатору має наступні атрибути:

  • активний

  • зареєстрований

  • заблокований

Атрибути наразі не використовуються.

Створення додаткового цифровізованого ідентифікатору

Ідентифікатори можуть створюватися наступним чином:

  1. При створенні сутності Контрагента автоматично створюється 2 ідентифікатори : Ідентифікаційний та Процесинговий.

  2. Працівник може створити додатковий Процесинговий ідентифікатор для свого Контрагента (наприклад, щоб розділити потік ідентифікаторів для Банкіу створюється окремий рахунок для відділення (філії) - див. нижче.

  3. При створенні сутності Клієнта, йому автоматично створюється ідентифікатор.

  4. Працівник може створити додатковий ідентифікатор для Клієнта (у кожного клієнта є свій обліковий запис в Stellar) - див. .

  5. Клієнт може створити обліковий запис власноруч через UI (ще не реалізовано).

Атрибут branch_guid необов'язковий.

Отримання списку ідентифікаторів

Отримати список ідентифікатор, створених ​​для користувача.

Фільтр search_string приймає такі значення:

  1. account_guid - унікальний запис ідентифікатору;

  2. account_iban - сутність запису в форматі IBAN (без пробілів);

  3. customer.login - логін Клієнта, який створюється при реєстрації Клієнта;

  4. customer.external_id - зовнішній ідентифікатор Клієнта, може збігатися з login;

Отримання деталей по певному ідентифікатору

За допомогою даного методу можна отримати деталі ідентифікатору для Контрагента (накшталт, отримати деталі рахунку в Банку).

Адміністратор може отримати всі доступні облікові записи по своєму Контрагенту.

Працівник Банку може отримати всі ідентифікатори по своєму Контрагенту, крім ідентифікатора Дистриб'ютора.

customer_guid - унікальний ідентифікатор Клієнта. Більше інформації можна знайти ;

🛠️
тут

Get accounts list

get

Get accounts list

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
wallet_account_guidsstring[]Optional

wallet account guid (uuid)

wallet_user_guidsstring[]Optional

wallet user guid (uuid)

account_kindsstring[]Optional

account kinds (string)

ibanstringOptional

iban

search_stringstringOptional

Parameter to search by guid, iban, login or external_id

offsetintegerOptional

offset (int)

orderstring · enumOptional

list order (string)

Possible values:
Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/accounts HTTP/1.1
Host: your_host
Accept: */*
[
  {
    "accounts": [
      {
        "account_kind": "processing",
        "counterparty_guid": "text",
        "created_at": "text",
        "iban": "text",
        "stellar_address": "text",
        "updated_at": "text",
        "wallet_account_guid": "text",
        "wallet_user_external_id": "text",
        "wallet_user_guid": "text"
      }
    ],
    "total": 1
  }
]

Get account

get

Get account

Path parameters
counterparty_guidstringRequired

Counterparty GUID

account_guidstringRequired

wallet account guid (uuid)

Query parameters
ibanstringOptional

iban (string)

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/accounts/{account_guid} HTTP/1.1
Host: your_host
Accept: */*
{
  "activated": true,
  "assets": [
    {
      "activated": true,
      "balance": 1,
      "code": "text",
      "minor_unit": 1,
      "name": "text",
      "platform": "text",
      "stellar_code": "text",
      "stellar_issuer": "text"
    }
  ],
  "assets_total": 1,
  "blocked": true,
  "guid": "text",
  "iban": "text",
  "name": "text",
  "platform": "text",
  "registered": true,
  "type": "text"
}
  • Створення додаткового цифровізованого ідентифікатору
  • POSTCreate account
  • Отримання списку ідентифікаторів
  • GETGet accounts list
  • Отримання деталей по певному ідентифікатору
  • GETGet account

Create account

post

Create account

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
account_kindall ofOptional

type of account: processing or emission (for branch accounts only processing type is possible)

Possible values:
string · enumOptionalPossible values:
ibanstringOptional
key_keeper_loginstringOptional
Responses
200
OK
application/json
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/accounts HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "account_kind": "processing",
  "iban": "text",
  "key_keeper_login": "text"
}
{
  "guid": "text"
}
Клієнти