Перейти к основному содержимому

Баланс мерчанта

Swagger - подробное API мерчанта.

Интерфейс тела запроса на проверку баланса мерчанта:

{
"publicKey": "string",
"hash": "string"
}

Таблица с описанием всех полей тела запроса:

ПолеТипОбязательныйОписание
publicKeyStringДаПубличный ключ, который выдавался при регистрации мерчанта на платформе FirstPay (Ключ передается в файле, нужно передать все его содержимое).
hashStringДаЗакодированная строка тела запроса. О том как ее сформировать - см. в разделе "Авторизация".

Таблица возвращаемых ответов:

codeТело ответаОписание
200Баланс мерчантаПри успешном запросе возвращаются данные по балансу мерчанта.
400{"error": "some text here..."}Ошибка возникает, если не удалось распарсить тело запроса и query параметры. (скорее всего они были переданы с ошибкой).
401{"error": "NO_LOGIN"}Ошибка возникает, если не передали в теле запроса поле publicKey.
401{"error": "NO_TOKEN"}Ошибка возникает, если не передали в теле запроса поле hash.
401{"error": "NO_KEY"}Ошибка возникает, если передан неправильный publicKey.
401{"error": "UNAUTHORIZED"}Ошибка возникает, если произошла ошибка при валидации publicKey и hash.
500{"error": "some text here..."}Ошибка возникает, когда сервер не смог обработать запрос и произошла какая-то не штатная ситуация.

Описание полей баланса мерчанта

Интерфейс баланса мерчанта:

{
"totalBalances": [{
"paymentMethodId": "string",
"totalBalance": "string",
"balance": "number" // Deprecated
}]
}

Таблица с описанием всех полей:

ПолеТипОписание
totalBalancesArrayМассив платёжных методов с балансом мерчанта.
paymentMethodIdStringИдентификатор/id платёжного метода.
totalBalanceStringБаланс мерчанта в рамках платёжного метода.
balance (deprecated)NumberБаланс мерчанта в рамках платёжного метода.