Баланс аккаунта — API Плати в Пути

GET/api/partner/v1/balance

Scope: любой ключ

Возвращает ваш предоплаченный баланс в USD.

Смотрите на available: выпуск и пополнение отклоняются с 402 balance_exhausted, как только он перестаёт покрывать операцию, даже если balance выглядит достаточным. Разница — средства, зарезервированные под операции в процессе.

balance может уйти в минус. Комиссии за транзакции по карте списываются уже после того, как карта заплатила мерчанту, поэтому отказать в них нельзя. Выпущенные карты продолжают работать; блокируются только новые операции, пока вы не пополните счёт.

Пример запроса

TS=$(date +%s)
SIG=$(printf '%s\n%s\n%s\n%s' "$TS" "GET" "/api/partner/v1/balance" "" \
  | openssl dgst -sha256 -hmac "$PP_SECRET" -hex | awk '{print $NF}')

curl -sS -X GET "https://api.plativputi.com/api/partner/v1/balance" \
  -H "X-Key-Id: $PP_KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"

const res = await pp("GET", "/balance");

res = pp("GET", "/balance")

$res = pp('GET', '/balance');

pp() — функция-обёртка с подписью из раздела Аутентификация и подпись.

Ответ

200 OK — BalanceDTO

Поле	Тип	Обяз.	Описание
`available`	string (decimal)	да	`balance` − `hold`. Новые операции принимаются, только пока он их покрывает
`balance`	string (decimal)	да	Учтённые средства
`currency`	string	да	Валюта счёта, всегда `USD`
`hold`	string (decimal)	да	Зарезервировано операциями в процессе

Примеры ответа

{
  "currency": "USD",
  "balance": "1250.5",
  "hold": "57.0464",
  "available": "1193.4536"
}