/Reverse

POST

/Reverse

The /Reverse request is used to cancel a payment for an order. This functionality is available within a limited period (specified by the bank) after a payment has been executed.
The reversal transaction may be performed only once for a payment. If a reversal request results in an error, the next try will fail.
Reversals are available to a merchant only if the merchant has an agreement with its bank to perform reversals. To perform the reversal request, a user must have the relevant permissions.

Request

Header Params

Body Params application/json

Example

{
    "pageData": {
        "language": "uk"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/537337-0-default/Reverse' \
--header 'ExtSystemid: ECOM_GOLD_BANK' \
--header 'login: SECURE_LOGIN' \
--header 'password: SECURE_PASSWORD' \
--header 'orderNumber: 1234' \
--header 'orderId: dbafea6c-3394-4f6a-a0d2-21d3d8e93e42' \
--header 'RegDate: 2023-09-12 12:16:00	' \
--header 'x-uws-clientdn: GOLDENBANK' \
--header 'accept;' \
--header 'charset;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageData": {
        "language": "uk"
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "orderParam": {
        "orderStatus": 3,
        "orderId": "0be41312-ce49-4a78-bd05-f8c647c6c488",
        "orderAuthParam": {
            "approvalCode": "113036",
            "authCode": 3
        }
    }
}

Modified at 2025-06-26 12:36:24

/ConfirmExt

/Refund