Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2152556.1 KB

Create Refund

Cashier's refund interface V2. Supports original or specified refund style, Gate or Web3 refund channel, and more options.

post/v2/standard/order/refund

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required
Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required
Example:1672905655498

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

X-GatePay-Noncestring required
Example:9578

Random nonce for replay attack prevention

Request body

refundRequestIdstring required

Merchant refund request ID

prepayIdstring required

Pre-order ID

refundAmountstring required

Refund amount

refundReasonstring required

Reason for refund

refundStyleinteger

1: Original, 2: Specified

refundPayChannelinteger

1: Gate, 2: Web3

refundToGateUidinteger

Gate user ID for refund recipient

refundAddressstring

Refund address

refundChainstring

Chain for refund

refundBearTypeinteger

1: Merchant, 2: User

memostring

Memo

needNotifyboolean

Whether to trigger refund result notification; true means notifications are sent to the callback URL configured for the merchant

refundLimitboolean

Refund limit flag

refundCurrencystring

Refund currency

refundFundStatementIdinteger

Refund fund statement ID

refundSourceinteger

0: Order, 1: Transaction

refundGateIdstring

Existing refund order ID for supplementary refund

refundAmountTypeFullinteger

Refund amount type: 1=full, 0=partial

emailCodestring

Email verification code

fundPassstring

Fund password

smsCodestring

SMS verification code

totpCodestring

TOTP verification code

adjustOrderIdinteger

Adjust order ID

opUserIdstring

Operator user ID

Response

Refund request submitted

statusstring

Response status

codestring

Response code

errorMessagestring

Error message