Отримання балансів по API
Інформація про баланс всіх доступних рахунків
Для отримання інформації про перелік всіх рахунків та стан їх балансів необхідно сформувати запит з методом GET
та таким набором параметрів:
Parameter | Type | Required | Description |
---|---|---|---|
POS_ID | UUID | ✅ | Merchant's identifier (POS_ID ) |
Приклад запиту:
$ curl
"https://api.tranzzo.com/api/v1/pos/${POS_ID}/accounts" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
Приклад тіла відповіді:
{
"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/pos/${POS_ID}/accounts/${ACCOUNT_ID}" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
Приклад тіла відповіді:
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"currency": "UAH",
"balances": {
"available": 0,
"rollingReserve": 0
}
}
інформація
Інформацію про ідентифікатор рахунку (account_id
) можна знайти у мерчант-порталі в розділі “Баланси”.
Можливі коди відповідей
Code | Description |
---|---|
200 | OK. All merchants' accounts with balances |
400 | Invalid data provided |
401 | Invalid credentials |
500 | Unexpected error |