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

Измените порядок

Заказ может быть отменен полностью или частично. Параметр amount должен быть передан в запросе на отмену и быть равен значению actual_amount заказа, если требуется полная отмена. order actual_amount value, если требуется полная отмена. Допускается несколько частичных отмен, при условии что сумма всех частичных отмен не превышает сумму заказа (actual_amount).

Идемпотентный ключ отмены

Идемпотентный ключ отмены reverse_id в запросе на отмену reverse request используется для обеспечения безопасных повторных попыток отмены. Обычно он не требуется для полной отмены. В случае частичной отмены идемпотентный ключ может защитить от многократных повторных попыток в случае ошибки.

Например, если сумма заказа составляет 1000 лари, а отправленная частичная отмена на сумму 100 лари завершилась сбоем из-за ошибки сети, чтобы убедиться, что еще одна попытка отмены на сумму 100 лари приведет к одной частичной отмене, а не к дублированию (100 + 100 = 200 лари), Каждая попытка должна отправляться с одинаковым значением параметра reverse_id.

Точка API для отмены заказа

Reverse the order

POST /api/reverse/order_id

Эта точка API ожидает POST-запрос в формате JSON с параметрами запроса.

Обычный ответ будет содержать параметр reverse_status, который указывает, была ли отмена успешной или нет.

Примеры запрос/ответ

curl -L 'https://pay.payme.uz/api/reverse/order_id' \
-H 'Content-Type: application/json' \
-d '{
  "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": "c703b3ce82aecfd2de633319685223347140717d",
        "reverse_id": "",
        "reversal_amount": "1",
        "transaction_id": "2011273408"
    }
}
{
    "response": {
        "error_code": 1007,
        "error_message": "Parameter `signature` is incorrect",
        "request_id": "HGh7ami3WN0ci",
        "response_status": "failure"
    }
}