Проверка получателя

Проверка получателя

POST /v2/recipient · Статус API: stable · Подпись: обязательна

Проверяет, существует ли получатель, до создания платежа. Рекомендуется вызывать перед POST /v2/payment, чтобы показать пользователю имя получателя и не отправить деньги «в никуда».

Тело запроса

ПараметрТипОбязательныйОписание
fieldsObjectОбязательноРеквизиты получателя парами ключ: значение, например "phone": "+996502502502". Набор полей зависит от услуги — см. requiredFields в POST /v2/services.
serviceStringОбязательноID услуги в домене Finik.

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

POST /v2/recipient
POST /v2/recipient HTTP/1.1
Host: api.paymentsgateway.averspay.kg
Content-Type: application/json
signature: <signature>
x-api-key: <apiKey>
x-api-timestamp: 1719900000000 // Use Date.now() for the current timestamp.

{
  "fields": {
    "amount": 100,
    "phone": "+996502502502"
  },
  "service": "averspay"
}

Ответ

ПараметрТипОбязательныйОписание
statusCodeNumberОбязательноСтатус ответа.
nameStringОпциональноФИО получателя, если поставщик услуг возвращает такие данные. Для услуги Finik — инициалы, например А. У.
phoneStringОпциональноРеквизит получателя. Присутствует для услуги Finik.

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

200 OK — получатель найден
{ "statusCode": 200, "name": "А. У.", "phone": "+996502502502" }
404 Not Found — получателя не существует
{ "statusCode": 404, "errorMessage": "User does not exist." }
400 Bad Request — получатель заблокирован
{ "statusCode": 400, "errorMessage": "User is disabled." }