/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

ExtSystemid

string

required

The identifier of the external system (ES) that generated the request. The identifier agrees with UKRKART during the registration of the ES

<= 50 characters

Example:

ECOM_GOLD_BANK

string

required

External system login received from UKRKARD during registration

<= 30 characters

Example:

SECURE_LOGIN

password

string

required

External system password received from UKRKARD during registration

>= 5 characters<= 30 characters

Example:

SECURE_PASSWORD

orderNumber

string

required

Number (identifier) of the order in the merchant’s online
store system. It is unique for every store in the system and
is generated on the order registration

<= 32 characters

Example:

1234

orderId

string

optional

Number generated by wsGate after the registration of the order.

>= 32 characters<= 32 characters

Example:

dbafea6c-3394-4f6a-a0d2-21d3d8e93e42

RegDate

string <date-time>

required

Date/time of the request in yyyy-MM-dd HH:mm:ss format

Example:

2023-09-12 12:16:00

Match pattern:

YYYY-MM-DD hh:mm:ss

x-uws-clientdn

string

required

The specified value must be equal to the value specified in the Common Name (CN) field for the client's SSL certificate

<= 500 characters

Example:

GOLDENBANK

enum<string>

required

application/json

Allowed value:

application/json

Content-Type

string

optional

application/json;charset=UTF-8

charset

string

optional

UTF-8

Body Params application/json

orderData

object

required

Transaction registration data

amount

number

150000

required

Order amount in the minor denomination (for example, cents). You can use a verification operation such as Debit Verify (which is similar to a Visa account and a Mastercard account) for a zero amount for additional 3DS authentication. For these operations, you must use the primary method /Payment with a zero amount. 3DS authentication will be present for MPS Visa and Mastercard cards. For NPS Prostir cards, the primary operation will be to verify the cloud record.

<= 10000000000000000000

currency

string

optional

Payment currency code in the ISO 4217 format. If it is not indicated, it must be entered equal to the currency code according to the rules (980 - UAH)

>= 3 characters<= 3 characters

externalFee

string

optional

Fee amount in the minor denomination of the currency. This can only be done for the p2pTransfer method

<= 9 characters

description

string

required

Free form description of the order.

<= 512 characters

pageData

object

required

External system page data

language

string

required

The language of the current page session

>= 2 characters<= 2 characters

Example:

returnUrl

string

required

URL to which the customer is redirected after a successful payment. The address must be specified in full, including the protocol used (for example, "https://test.ua" instead of test.ua). Otherwise, the user will be redirected to the default address

<= 512 characters

failUrl

string

required

Web address to which the customer is redirected if the payment fails. The address must be specified in full, including the protocol used (for example, https://test.ua instead of test.ua). Otherwise, the user will be redirected by default

<= 512 characters

jsonParams

object

optional

Block for transmitting additional merchant parameters

merchantIdType

string

optional

Document type
Possible values:
IDTP01 – Passport
IDTP0010 – Taxpayer ID (ІПН)
IDTP0016 – Company registration number (код ЄДРПОУ)
Example:
{"name":"merchantIdType","value":"IDTP01"}

merchantIdNumber

string

optional

Document details
varchar (13)
Example:
{"name":"merchantIdNumber","value":"ABCDXYZ124"}

Example

{
  "orderData": {
    "amount": 10000,
    "currency": 980,
    "description": "Payment for order 1373642"
  },
  "pageData": {
    "language": "uk"
  }
}

Request 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

orderParam

object

required

Реєстраційні дані операції

orderStatus

integer

required

Стан операції

orderId

string

required

Унікальний ідентифікатор операції у системі. Автоматично надається системою при обробці запиту на реєстрацію замовлення

Example:

1c01e06f-c3da-4afe-94d4-8de1311c720f

orderVerifyFlag

integer

required

Ознака способу автентифікації операції
- 0 - 3Ds автентифікація;
- 1 Аутентифікація через otp пароль тільки для НПС «ПРОСТІР»
- null або параметр відсутня - відсутня 3D аутентифікація

orderAuthParam

object

required

Авторизаційні параметри

fee

object | null

required

Дані про комісію. Може бути відсутнім, якщо не заповнений Param у разі перекладу p2p для якого не запитується комісія

feeAmount

string

optional

feeCurrency

string

optional

auth3DData

object

required

Дані, необхідні для виконання процедури 3-D Secure аутентифікації емітентом. Може бути відсутнім, якщо orderVerifyFlag = 1

acsurl

string

required

paReq

null

required

creq

string

required

jsonParams

object

optional

Block for transmitting additional merchant parameters.

merchantIdType

string

optional

Document type
Possible values:
IDTP01 – Passport
IDTP0010 – Taxpayer ID (ІПН)
IDTP0016 – Company registration number (код ЄДРПОУ)
Example:
{"name":"merchantIdType","value":"IDTP01"}

merchantIdNumber

string

optional

Document details
varchar (13)
Example:
{"name":"merchantIdNumber","value":"ABCDXYZ124"}

Example

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

Modified at 2025-02-25 13:09:11

/Reverse

/Verify