Skip to main content
POST
/
v1
/
pay
/
checkout
/
refund
Checkout Refund
curl --request POST \
  --url http://sandbox.mintlify.com/v1/pay/checkout/refund \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "refundRequestId": "100036668891329",
  "prepayId": "93752669101887488",
  "refundOrderCurrency": "USDT",
  "refundOrderAmount": "100",
  "refundPayCurrency": "USDT",
  "refundPayAmount": "50",
  "refundReason": "test refund",
  "receiverId": 6790011
}
'
{
  "status": "SUCCESS",
  "code": "00000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "32111114322523534534",
    "prepayId": "50620368071692288",
    "orderCurrency": "BTC",
    "orderAmount": "2",
    "refundOrderAmount": "1",
    "payCurrency": "BTC",
    "payAmount": "2",
    "refundPayAmount": "0"
  }
}

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

HMAC-SHA256 signature for request validation

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
required

Timestamp in milliseconds, must not differ from server time by more than 5 minutes

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Example:

"9578"

Body

application/json

Legacy refund request parameters

refundRequestId
string
required

Merchant refund request ID

prepayId
string
required

Pre-order ID

refundOrderCurrency
string
required

Order currency for refund

refundOrderAmount
string
required

Refund amount in order currency

refundPayCurrency
string
required

Payment currency for refund (No Convert scenario)

refundPayAmount
string
required

Refund amount in payment currency (No Convert scenario)

refundReason
string
required

Reason for refund

receiverId
integer<int64>
required

User ID of recipient

Response

200 - application/json

Refund request submitted

status
string

Response status

Example:

"SUCCESS"

code
string

Response code

Example:

"00000"

errorMessage
string

Error message

data
object