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

Нижче вказані наступні можливості роботи з ідентифікаторами:

  • Ідентифікатори

  • переглянути Ідентифікатори

  • Ідентифікатори

До інформації:

  1. операція створення та видалення ідентифікаторів потребує схвалення працівника з боку DCM

  2. тільки 1 запит на створення або видалення ідентифікаторів може мати статус «створено».

Створення ідентифікатору(ів)

Щоб створити ідентифікатори, використовуйте цю кінцеву точку:

Має бути виконана умова:

ReserveAccBalance>=sum(create)−sum(delete)+XReserve Acc Balance >= sum(create) - sum(delete) + XReserveAccBalance>=sum(create)−sum(delete)+X

де:

  • X - необхідну суму для створення

  • sum(A) - історія всіх створених або видалених ідентифікаторів

Історія ідентифікатора(ів)

Щоб переглянути історію ідентифікатора, використовується наступний запит:

Видалення ідентифікатору(ів)

Щоб видалити ідентифікатори, використовується наступний запит:

За домовленністю: Має бути виконана умова:

ReserveAccBalance>=sum(create)−sum(delete)−YReserve Acc Balance >= sum(create) - sum(delete) - YReserveAccBalance>=sum(create)−sum(delete)−Y

де:

  • Y - запитану суму для видалення

  • sum(A) - історія всіх створених або видалених ідентифікаторів

🛠️

Assets history

get

Assets history

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
guidstringOptional

Emission GUID

directionstringOptional

Direction

balance_guidstringOptional

Balance GUID

asset_guidstringOptional

Asset GUID

issuer_payment_guidstringOptional

Issuer payment GUID

emission_payment_guidstringOptional

Emission payment GUID

issuer_payment_hashstringOptional

Issuer payment hash

emission_payment_hashstringOptional

Emission payment hash

statusstringOptional

Status

created_bystringOptional

Created by

updated_bystringOptional

Updated by

min_created_atstringOptional

Min created_at

max_created_atstringOptional

Max created_at

min_updated_atstringOptional

Min updated_at

max_updated_atstringOptional

Max updated_at

orderstring · enumOptional

Sorting order

Possible values:
offsetintegerOptional

Offset

limitintegerOptional

Limit

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/emission/history HTTP/1.1
Host: your_host
Accept: */*
{
  "history": [
    {
      "balance": {
        "asset_guid": "text",
        "counterparty_guid": "text",
        "created_at": "text",
        "emission_account_guid": "text",
        "guid": "text",
        "reserve_balance_amount": 1,
        "updated_at": "text"
      },
      "created_at": "text",
      "created_by": "text",
      "direction": "text",
      "emission_payment_guid": "text",
      "emission_payment_hash": "text",
      "guid": "text",
      "issuer_payment_guid": "text",
      "issuer_payment_hash": "text",
      "requested_amount": 1,
      "reserve_balance_amount": 1,
      "status": "text",
      "updated_at": "text",
      "updated_by": "text"
    }
  ],
  "total": 1
}
  • Створення ідентифікатору(ів)
  • POSTIssue asset
  • Історія ідентифікатора(ів)
  • GETAssets history
  • Видалення ідентифікатору(ів)
  • POSTBurn asset

Issue asset

post

Issue asset

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
amountnumberOptional

amount of issued assets

asset_codestringOptional

asset code that will be created

asset_issuerstringOptional

address in stellar which will issue token

reserve_balancenumberOptional

optional reserve balance

Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/emission/issue HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "reserve_balance": 1
}
{}

Burn asset

post

Burn asset

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
amountnumberOptional

amount of tokens that will be burnt

asset_codestringOptional

asset's code

asset_issuerstringOptional

address in stellar that is the issuer address

reserve_balancenumberOptional

optional reserve balance

Responses
200
OK
application/json
Responseobject
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/emission/burn HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "reserve_balance": 1
}
{}