Работа с postback запросами
Интерфейс тела запроса
{
"publicKey": "string",
"hash": "string",
"id": 0,
"status": "string",
"failedCode": "string" || null,
"paymentMethodId": "string",
"amount": 0,
"currency": "string",
"clientFieldsValues": [
{
"key": "string",
"value": "string"
}
],
"merchantPaymentId": "string",
"merchantUserId": "string",
"createdAt": "2023-11-13T20:20:15.221Z",
"payments": [
{
"id": 0,
"status": "string",
"failedCode": "string" || null,
"paymentMethodId": "string",
"amount": 0,
"currency": "string",
"clientFieldsValues": [
{
"key": "string",
"value": "string"
}
],
"merchantPaymentId": "string",
"merchantUserId": "string",
"createdAt": "2023-11-13T20:20:15.221Z"
}
]
}
Таблица с описанием всех полей тела запроса
| Поле | Тип | Обязательный | Описание | |||||
|---|---|---|---|---|---|---|---|---|
| publicKey | String | Да | Публичный ключ FirstPay, который необходим для валидации тела запроса. | |||||
| hash | String | Да | Закодированная строка тела запроса. О том как ее валидировать - см. в разделе "Авторизация". | |||||
| id | Number | Да | ID платежа в системе FirstPay. | |||||
| status | Enum | Да | Status платежа в системе FirstPay. В ответе всегда будет приходить либо SUCCESS, либо FAILED. | |||||
| failedCode | Enum | Да | Данное поле характеризует ошибку при осуществлении платежа. Если status=`SUCCESS`, то в данном поле придет `null`. Если же status=`FAILED`, то failedCode будет содержать одно из значений: `INCORRECT_AMOUNT` (перечислено некорректное кол-во денежных средств), `NO_AMOUNT` (денежные средства не были перечислены), `INCORRECT_FIELDS` (поля в форме были заполнены неправильно), `ANOTHER_REASON` (другая ошибка, не относящаяся к вышеперечисленным). | |||||
| paymentMethodId | String | Да | ID платежного метода. | |||||
| amount | Number | Да | Сумма платежа. | |||||
| currency | Enum | Да | ISO код валюты: USD, INR, BDT, PKR и тд. | |||||
| clientFieldsValues | Array | Да | Список заполненных полей пользователем. Все эти поля отправляются при создании платежа мерчантом. | |||||
| key | String | Да | Идентификатор/id поля. | |||||
| value | String | Да | Значение, заполненное пользователем. | |||||
| merchantPaymentId | String | Нет | Опциональное поле. ID платежа в системе мерчанта. Передается, если было указано при создании платежа. | |||||
| merchantUserId | String | Нет | Опциональное поле. ID пользователя в системе мерчанта. Передается, если было указано при создании платежа. | |||||
| createdAt | String | Да | UTC Timestamp создания платежа. | |||||
| payments (deprecated) | Array | Да | Массив платежей пользователя. | |||||
| id | Number | Да | ID платежа в системе FirstPay. | |||||
| status | Enum | Да | Status платежа в системе FirstPay. В ответе всегда будет приходить либо SUCCESS, либо FAILED. | |||||
| failedCode | Enum | Да | Данное поле характеризует ошибку при осуществлении платежа. Если status=`SUCCESS`, то в данном поле придет `null`. Если же status=`FAILED`, то failedCode будет содержать одно из значений: `INCORRECT_AMOUNT` (перечислено некорректное кол-во денежных средств), `NO_AMOUNT` (денежные средства не были перечислены), `INCORRECT_FIELDS` (поля в форме были заполнены неправильно), `ANOTHER_REASON` (другая ошибка, не относящаяся к вышеперечисленным). | |||||
| paymentMethodId | String | Да | ID платежного метода. | |||||
| amount | Number | Да | Сумма платежа. | |||||
| currency | Enum | Да | ISO код валюты: USD, INR, BDT, PKR и тд. | |||||
| clientFieldsValues | Array | Да | Список заполненных полей пользователем. Все эти поля отправляются при создании платежа мерчантом. | |||||
| key | String | Да | Идентификатор/id поля. | |||||
| value | String | Да | Значение, заполненное пользователем. | |||||
| merchantPaymentId | String | Нет | Опциональное поле. ID платежа в системе мерчанта. Передается, если было указано при создании платежа. | |||||
| merchantUserId | String | Нет | Опциональное поле. ID пользователя в системе мерчанта. Передается, если было указано при создании платежа. | |||||
| createdAt | String | Да | UTC Timestamp создания платежа. | |||||