Sign in

v1

latestOpenAPI 3.1.02026-07-2182453.1 KB

Refund (Direct Payment)

Initiate a refund for the direct address payment order, which is only applicable to the direct address payment order.

post/v1/pay/address/refund

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required

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

X-GatePay-Noncestring required

Random nonce for replay attack prevention

Request body

clientIdstring

Client ID

mIdinteger

Merchant ID (internal)

refundGateIdstring required

The merchant's refund request ID

prepayIdstring required

The ID of the corresponding payment order

refundAmountstring required

The amount to be refunded

refundReasonstring

The reason for the refund

receiverIdstring required

The Gate user ID of the recipient of the refund for address payment

Response

SUCCESS

refundRequestIdstring

Merchant's refund request id

prepayIdstring

The id of the payment order to be refunded

orderAmountstring

The amount of the original payment order

refundAmountstring

The amount to be refunded