/Refund

POST

/Refund

A /Refund request is used to refund deposited money.
This request returns the funds paid for the order back to the customer. The request results in an error if the customer was not charged. Under rules only the Refund request allows multiple refunds, but their total amount cannot exceed the amount that was deposited from the customer’s account as a result of the order.
A merchant’s user must have a corresponding permission in the system to perform a refund request.

Request

Header Params

Body Params application/json

Example

{
    "orderData": {
        "amount": 10000,
        "currency": 980,
        "description": "Payment for order 1373642"
    },
    "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/Refund' \
--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 '{
    "orderData": {
        "amount": 10000,
        "currency": 980,
        "description": "Payment for order 1373642"
    },
    "pageData": {
        "language": "uk"
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "orderParam": {
        "orderStatus": 4,
        "orderId": "3094bcd3-25f4-4acc-be58-5ab47cdcb7ac",
        "orderAuthParam": {
            "approvalCode": "114383",
            "authCode": 4
        }
    }
}

Modified at 2025-06-26 12:37:16

/Reverse

/Verify