Skip to main content
POST
/
payment
/
open
/
institution
/
v1
/
pay
/
address
/
refundconvert
Refund (Convert Payment)
curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/refundconvert \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "refundRequestId": "483902480932841787",
  "prepayId": "1665553233227833",
  "refundOrderCurrency": "BTC",
  "refundPayCurrency": "USDT",
  "refundReason": "refund test",
  "receiverId": 123456
}
'
{
  "status": "SUCCESS",
  "code": "00000",
  "errorMessage": "",
  "data": {
    "refundRequestId": "483902480932841787",
    "prepayId": "1665553233227833",
    "orderCurrency": "BTC",
    "orderAmount": "2.2",
    "refundOrderAmount": "1.1",
    "payCurrency": "USDT",
    "payAmount": "44000",
    "refundPayAmount": "1000.1"
  }
}

​
Overview

This page documents the POST /payment/open/institution/v1/pay/address/refundconvert endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above. Initiate a refund for the convert address payment order, which is only applicable to the convert address payment order. If the provided parameters correspond to the direct payment order, an error message will be returned.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature for request validation

​
X-GatePay-Timestamp
string
required

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

​
X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

​
X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Body

application/json
​
refundRequestId
string
required

Merchant request refund number

​
prepayId
string
required

Payment order ID for refund

​
refundOrderCurrency
string
required

Refund order currency

​
refundPayCurrency
string
required

Refund payment currency

​
refundReason
string
required

Reason for refund

​
receiverId
string
required

Gate system user ID for refund recipient in address payment

​
refundPayAmount
string

Refund payment amount in the corresponding currency

Response

200 - application/json

SUCCESS

Response to request for refund of convert payment order

​
status
string
​
code
string
​
errorMessage
string
​
data
object