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

Ліміти обмежують вихідні трансфери залежно від періоду та типу ідентифікатору (визначається сегментом).

Обсяг обмежень має 2 виміри:

  • Приналежність

    • один Клієнт

    • або всі Клієнти в сегменті

  • Тимчасовість

    • за один трансфер

    • або для всіх трансферів протягом дня, тижня, місяця чи року.

1. Індивідуальні ліміти

Індивідуальні ліміти обмежують трансфери для конкретного Клієнта.

1.1 Ліміт на одну операцію

Отримання індивідуальних обмеження на трансфер

Встановити індивідуальний ліміт на трансфер для Клієнта

Де можна взяти ці параметри?

За допомогою методу "Отримання списоку облікових записів" можна отримати такі параметри:

  • customer_guid = wallet_user_guid- ідентифікатор клієнта, для якого встановлюється обмеження

  • account_type_guid = wallet_account_guid - ідентифікатор типу облікового запису

За допомогою методу "Отримання списоку облікових записів Клієнтів" можна отримати наступні параметри:

  • asset_code = stellar_code

  • asset_issuer = stellar_issuer

1.2 Ліміт на певний період часу

Get individual limits per customer

Комбінації:

  1. періоди дефолту

    • period=[day/week/month/year]

    • period_key = 1

  2. кількість днів для спеціального періоду

    • period="days"

    • period_key = 180

Встановлення індивідуальних лімітів для кожного Клієнта

Де можна взяти ці параметри?

За допомогою методу "Отримання списоку облікових записів" можна отримати такі параметри:

  • customer_guid = wallet_user_guid- ідентифікатор Клієнта, для якого встановлюється обмеження

  • account_type_guid = wallet_account_guid - ідентифікатор типу облікового запису

За допомогою методу "Отримання списоку облікових записів Клієнтів" можна отримати наступні параметри:

  • asset_code = stellar_code

  • asset_issuer = stellar_issuer

2. Стандартні обмеження

Стандартні ліміти обмежують трансфери для Клієнтів з певним сегментом та ідентифікатором.

2.1 Ліміт на одну операцію

Отримання стандартних обмежень на трансфер для всіх сегментів

Встановлення стандартного ліміту на трансфер для сегмента

Де можна взяти ці параметри?

За допомогою методу "Отримання списоку облікових записів" можна отримати такі параметри:

  • customer_guid = wallet_user_guid- ідентифікатор клієнта, для якого встановлюється обмеження

  • account_type_guid = wallet_account_guid - ідентифікатор типу облікового запису

За допомогою методу "Отримання списоку облікових записів Клієнтів" можна отримати наступні параметри:

  • asset_code = stellar_code

  • asset_issuer = stellar_issuer

2.2 Ліміт на певний період часу

Отримання стандартних лімітів Клієнтів для всіх сегментів

Встановлення стандартного ліміту Клієнтів для сегмента

Де можна взяти ці параметри?

За допомогою методу "Отримання списоку облікових записів" можна отримати такі параметри:

  • customer_guid = wallet_user_guid- ідентифікатор клієнта, для якого встановлюється обмеження

  • account_type_guid = wallet_account_guid - ідентифікатор типу облікового запису

За допомогою методу "Отримання списоку облікових записів Клієнтів" можна отримати наступні параметри:

  • asset_code = stellar_code

  • asset_issuer = stellar_issuer

🛠️

Get customer amount limit

get

Get customer amount limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
customer_guidstringOptional

Customer GUID (uuid)

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/limits/customer/amount HTTP/1.1
Host: your_host
Accept: */*
{
  "columns": [
    {
      "account_type_guid": "text",
      "asset_code": "text",
      "asset_issuer": "text",
      "customer_guid": "text",
      "period": {
        "ANY_ADDITIONAL_PROPERTY": {
          "max": 1,
          "period_key": 1
        }
      }
    }
  ]
}

Get customer payment amount limit

get

Get customer payment amount limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
customer_guidstringOptional

Customer GUID (uuid)

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/limits/customer/payment HTTP/1.1
Host: your_host
Accept: */*
{
  "columns": [
    {
      "account_type_guid": "text",
      "asset_code": "text",
      "asset_issuer": "text",
      "customer_guid": "text",
      "max": 1,
      "min": 1
    }
  ]
}

Get operation limits

get

Get operation limits

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/limits/operations HTTP/1.1
Host: your_host
Accept: */*
{
  "columns": [
    {
      "account_type_guid": "text",
      "asset_code": "text",
      "asset_issuer": "text",
      "max": 1,
      "min": 1
    }
  ]
}

Get users limits

get

Get users limits

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Responses
200
OK
application/json
400
json with error msg
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/limits/users HTTP/1.1
Host: your_host
Accept: */*
{
  "columns": [
    {
      "account_type_guid": "text",
      "asset_code": "text",
      "asset_issuer": "text",
      "period": {
        "ANY_ADDITIONAL_PROPERTY": {
          "max": 1,
          "period_key": 1
        }
      }
    }
  ]
}
  • 1. Індивідуальні ліміти
  • 1.1 Ліміт на одну операцію
  • GETGet customer amount limit
  • POSTSet customer amount limit
  • 1.2 Ліміт на певний період часу
  • GETGet customer payment amount limit
  • POSTSet customer payment amount limit
  • 2. Стандартні обмеження
  • 2.1 Ліміт на одну операцію
  • GETGet operation limits
  • POSTCreate operation limit
  • 2.2 Ліміт на певний період часу
  • GETGet users limits
  • POSTCreate users limit

Set customer amount limit

post

Set customer amount limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
account_type_guidstringOptional
asset_codestringOptional
asset_issuerstringOptional
customer_guidstringOptional
maxnumberOptional
periodstring · enumOptionalPossible values:
period_keyintegerOptional
Responses
200
OK
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/limits/customer/amount HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "account_type_guid": "text",
  "asset_code": "text",
  "asset_issuer": "text",
  "customer_guid": "text",
  "max": 1,
  "period": "day",
  "period_key": 1
}

No content

Set customer payment amount limit

post

Set customer payment amount limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
account_type_guidstringOptional
asset_codestringOptional
asset_issuerstringOptional
customer_guidstringOptional
maxnumberOptional
periodstring · enumOptionalPossible values:
period_keyintegerOptional
Responses
200
OK
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/limits/customer/payment HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "account_type_guid": "text",
  "asset_code": "text",
  "asset_issuer": "text",
  "customer_guid": "text",
  "max": 1,
  "period": "day",
  "period_key": 1
}

No content

Create operation limit

post

Create operation limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
account_type_guidstringOptional
asset_codestringOptional
asset_issuerstringOptional
maxnumberOptional
minnumberOptional
Responses
200
OK
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/limits/operations HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "account_type_guid": "text",
  "asset_code": "text",
  "asset_issuer": "text",
  "max": 1,
  "min": 1
}

No content

Create users limit

post

Create users limit

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
account_type_guidstringOptional
asset_codestringOptional
asset_issuerstringOptional
maxnumberOptional
periodstring · enumOptionalPossible values:
period_keyintegerOptional
Responses
200
OK
400
json with error msg
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/limits/users HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "account_type_guid": "text",
  "asset_code": "text",
  "asset_issuer": "text",
  "max": 1,
  "period": "day",
  "period_key": 1
}

No content