Обратные параметры¶
Параметры запроса
| Параметры | Тип | Обязательный | Описание |
|---|---|---|---|
version |
string(10) | необязательный | Версия протокола. Значение по умолчанию: 1.0.1 Версия 1.0 устарела |
order_id |
string(1024) | обязательный | Идентификатор заказа, сгенерированный мерчантом |
merchant_id |
integer(12) | обязательный | Уникальный идентификатор мерчанта. Генерируется Paymeпри регистрации мерчанта |
amount |
integer(12) | обязательный | Сумма заказа без разделителя |
currency |
string(3) | обязательный | Валюта заказа. Поддерживаемые значения: EUR — евро USD — доллар США GBP — фунт стерлингов CZK — чешская крона GEL — грузинский лари UZS — узбекский сум Полный список поддерживаемых валют |
email |
string(254) | необязательный | Адрес электронной почты сотрудника мерчанта, инициировавшего отмену |
comment |
string(1024) | необязательный | Комментарий продавца о причине отмены UTF-8 |
reverse_id |
string(50) | необязательный | Идемпотентный ключ отмены для безопасной повторной попытки возврата. Мерчант должен сгенерировать уникальное значение для каждой повторной попытки по order_id |
signature |
string(40) | обязательный | Подпись заказа. Требуется для проверки согласованности и подлинности запроса мерчанта. Алгоритм генерации подписи см. на Генерация подписи для запроса и ответа и response |
| Параметры | Тип | Описание |
|---|---|---|
order_id |
string(1024) | Идентификатор заказа, сгенерированный мерчантом. |
merchant_id |
integer(12) | Уникальный идентификатор мерчанта. Генерируется Paymeво время регистрации мерчанта. |
currency |
string(3) | Валюта заказа. Поддерживаемые значения: см. Currencies |
reverse_status |
string(50) | Статус обработки заказа. Может содержать следующие значения: created — заказ создан, но клиент еще не ввел платежные данные; мерчант должен продолжать запрашивать статус заказа processing — заказ все еще обрабатывается платежным шлюзом; продавец должен продолжать запрашивать статус заказа declined — заказ отклонен платежным шлюзом Payme , банком или внешней платежной системой approved — заказ успешно завершен, средства удержаны на счете плательщика и вскоре будут зачислены продавцу; продавец может предоставить услугу или отправить товар expired — срок действия заказа lifetime истек. reversed — ранее одобренная транзакция была полностью отменена. В этом случае параметр reversal_amount будет равен actual_amount |
response_status |
string(50) | Статус обработки запроса. Если параметры, отправленные мерчантом, не прошли валидацию, то статус — «failure», в противном случае — «success» |
reverse_id |
string(50) | необязательный |
transaction_id |
string(50) | необязательный |
signature |
string(40) | Подпись заказа. Требуется для проверки согласованности и подлинности запроса мерчанта. Алгоритм генерации подписи см. по адресу Генерация подписи для запроса и ответа и response |
response_code |
integer(4) | Код ответа об отклонении заказа. Возможные коды см. в разделе «Коды ответов» |
response_description |
string(1024) | Описание кодов ответов на запросы, см. Коды ответов |
comment |
string(1024) | Комментарий продавца о причине отмены UTF-8 |
Примеры
{
"request": {
"order_id": "test_12343242111",
"currency": "UZS",
"amount": "1",
"signature": "29a569275265925c2ec356d3adada1929fd8bb8c",
"merchant_id": "4056281"
}
}
{
"response": {
"reverse_status": "approved",
"order_id": "test_12343242111",
"response_description": "",
"response_code": "",
"merchant_id": 4056281,
"response_status": "success",
"signature": "3656398d3e2aaf83138223cf97ce497871495904",
"reverse_id": "",
"reversal_amount": "16",
"transaction_id": "2011080263"
}
}
{
"response": {
"error_code": 1007,
"error_message": "Parameter `signature` is incorrect",
"request_id": "e96rGwTzLjFmR",
"response_status": "failure"
}
}