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

Подтверждение по SMS

Swagger - подробное API платежей.

Интерфейс тела запроса на подтверждение создания платежа по SMS:

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

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

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

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

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

Описание полей ответа

Интерфейс ответа:

{
"isSucceed": true
}

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

ПолеТипОписание
isSucceedBooleanУспех.