Перейти к содержанию

Базовая информация

Универсальные параметры

Api-ключ Type Format Description
X-Api-Key string max: 255 API-ключ
sign_key string max: 255 Симметричный ключ для подписи
В примерах используется значение:
" your_secret_key_here "
merchant string Наименование вашего мерчанта
order_id string max: 255 id заявки на оплату/выплату

Методика формирования стандартной подписи (standart_sign)

Стандартная подпись формируется путем нахождения SHA256 Хеша от строки:

order_id : sign_key

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

Name Type Format Description
ok* boolean Статус ответа
error string max: 2056 Описание ошибки

Получение статуса мерчанта

Запрос

GET example.com/api/merchant/"merchant"/status/

Заголовки

Name Value
Content-Type* application/json
X-Api-Key* X-Api-Key

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

Name Type Format Description
balance* number double Ваш баланс в usdt
hold* number double Ваш холд в usdt (считается по сумме заявок на выплаты в ожидании)
available* number double Доступные вам средства в usdt
payment_ecom_statuses* object Объект со статусами работы платежного шлюза
payment_ecom_statuses.russian* boolean Статус работы оплаты через платежный шлюз для российских платежей (вкл/выкл)
payment_ecom_statuses.international* boolean Статус работы оплаты через платежный шлюз для международных платежей (вкл/выкл)
payment_methods array Массив с информацией о статусах доступных методов оплаты и выплаты по каждой валюте (гео)
payment_methods[].currency string Код валюты
payment_methods[].statuses object Объект со статусами методов оплаты/выплаты
payment_methods[].statuses.pay_in_sbp boolean Статус работы оплаты по СБП (вкл/выкл)
payment_methods[].statuses.pay_in_card boolean Статус работы оплаты по картам (вкл/выкл)
payment_methods[].statuses.pay_in_score boolean Статус работы оплаты по номеру счёта (вкл/выкл)
payment_methods[].statuses.pay_in_iban boolean Статус работы оплаты по IBAN (вкл/выкл)
payment_methods[].statuses.pay_out_sbp boolean Статус работы выплат по СБП (вкл/выкл)
payment_methods[].statuses.pay_out_card boolean Статус работы выплат по картам (вкл/выкл)
payment_methods[].statuses.pay_out_score boolean Статус работы выплат по номеру счёта (вкл/выкл)
payment_methods[].statuses.pay_out_iban boolean Статус работы выплат по IBAN (вкл/выкл)

Примечание: Обратите внимание, в объектах payment_methods для каждой валюты возвращаются только те параметры, которые указаны для неё в доступных методах pay_in и pay_out соответственно.

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

{
  "ok": true,
  "balance": 3000.45,
  "hold": 1354.35,
  "available": 1646.1,
  "payment_ecom_statuses": {
    "russian": true,
    "international": true
  },
  "payment_methods": [
    {
      "currency": "rub",
      "statuses": {
        "pay_in_sbp": true,
        "pay_in_card": true,
        "pay_in_score": true,
        "pay_out_sbp": false,
        "pay_out_card": true,
        "pay_out_score": false
      }
    },
    {
      "currency": "uzs",
      "statuses": {
        "pay_in_score": true,
        "pay_out_score": true
      }
    },
    {
      "currency": "kzt",
      "statuses": {
        "pay_in_card": true,
        "pay_out_card": true
      }
    }
  ]
}
{
  "ok": false,
  "error": "message"
}