Отримання балансів по API

Інформація про баланс всіх доступних рахунків

Для отримання інформації про перелік всіх рахунків та стан їх балансів необхідно сформувати запит з методом GET та таким набором параметрів:

Parameter	Type	Required	Description
POS_ID	UUID	✅	Merchant's identifier (POS_ID)

Приклад запиту:

$ curl "https://api.tranzzo.com/api/v1/balances/pos/${POS_ID}/accounts" \
   -H "X-API-AUTH: CPAY-HMAC-SHA1 ${API_KEY}:${SIGNATURE}" 

Приклад тіла відповіді:

{
  "accounts": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "currency": "UAH",
      "balances": {
        "available": 0,
        "rolling_reserve": 0
      }
    }
  ]
}

Інформація про баланс конкретного рахунку

Для отримання інформації про баланс одного рахунку необхідно сформувати запит з методом GET та таким набором параметрів:

Parameter	Type	Required	Description
POS_ID	UUID	✅	Merchant's identifier (POS_ID)
ACCOUNT_ID	UUID	✅	Account identifier

Приклад запиту на отримання інформації про баланс рахунку:

$ curl "https://api.tranzzo.com/api/v1/balances/pos/${POS_ID}/accounts/${ACCOUNT_ID}" \
   -H "X-API-AUTH: CPAY-HMAC-SHA1 ${API_KEY}:${SIGNATURE}" 

Приклад тіла відповіді:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "currency": "UAH",
  "balances": {
    "available": 0,
    "rollingReserve": 0
  }
}

інформація

Інформацію про ідентифікатор рахунку (account_id) можна знайти у мерчант-порталі в розділі “Баланси”.

Інформація про баланс всіх доступних терміналів

Для отримання інформації про перелік всіх доступних для перегляду терміналів та стан їх балансів необхідно сформувати запит з методом GET та таким набором параметрів:

Parameter	Type	Required	Description
POS_ID	UUID	✅	Merchant's identifier (POS_ID)

Приклад запиту:

$ curl "https://api.tranzzo.com/api/v1/balances/pos/${POS_ID}/terminals" \
   -H "X-API-AUTH: CPAY-HMAC-SHA1 ${API_KEY}:${SIGNATURE}" 

Приклад відповіді:

{
 "terminals": [
   {
     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "name": "string",
     "currency": "UAH",
     "balances": {
       "available": 100
     }
   },
   {
     "id": "5fa85f64-5717-4562-b3fc-2c963f66afa6",
     "name": "string",
     "currency": "UAH",
     "balances": {
       "available": 50
     }
   }
 ]
}

Обробка помилок

У випадку, якщо серед доступних терміналів є ті, що не повертають баланс, сервіс поверне відповідь наступного формату:

{
 "terminals": [
   {
     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "name": "string",
     "currency": "UAH",
     "balances": {
       "available": 100
     }
   }
 ],
 "failed_terminals": [
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "message": "The terminal balance is temporarily unavailable"
  },
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "message": "The terminal balance is temporarily unavailable"
  }
 ]
}

Інформація про баланс конкретного термінала

Для отримання інформації про баланс конкретного термінала необхідно сформувати запит з методом GET та таким набором параметрів:

Parameter	Type	Required	Description
POS_ID	UUID	✅	Merchant's identifier (POS_ID)
TERMINAL_ID	UUID	✅	Account identifier.

Приклад запиту:

$ curl "https://api.tranzzo.com/api/v1/balances/pos/${POS_ID}/terminals/${TERMINAL_ID}" \
   -H "X-API-AUTH: CPAY-HMAC-SHA1 ${API_KEY}:${SIGNATURE}" 

Приклад відповіді:

{
 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "name": "string",
 "currency": "UAH",
 "balances": {
   "available": 100
 }
}

інформація

Інформацію про ідентифікатор терміналу (terminal_id) можна отримати, звернувшись до нашої служби підтримки.

Можливі коди відповідей

Code	Description
200	OK. All merchants' accounts with balances
400	Invalid data provided
401	Invalid credentials
500	Unexpected error