v1

latestOpenAPI 3.1.02026-07-2182453.1 KB

Place Order

Create an order. When the order currency and payment currency are consistent, create a direct address payment order; if the order currency and payment currency are inconsistent, create a convert address payment order.

post/v1/pay/address/create

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

merchantTradeNostring required

Merchant transaction ID in the merchant's system.

currencystring

Crypto order currency.

orderAmountstring

Crypto order amount.

toleranceAmountstring

Tolerance Amount：If the remaining unpaid amount is less than or equal to the configured tolerance amount, the order will be automatically marked as Paid, with no further payment required.

fiatCurrencystring

Fiat order currency in uppercase form, such as EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF.

fiatAmountstring

Fiat order amount, with a maximum precision of 2 digits.

surchargeAmountstring

Surcharge, a fee borne by the consumer.

payCurrencystring

User-selected payment currency, not required for non-flash payment orders.

orderExpireTimeinteger required

Merchant-specified expiration time of the order, in milliseconds.

returnUrlstring

Callback URL for payment completion.

cancelUrlstring

Callback URL for payment cancellation.

merchantUserIdinteger required

Unique consumer ID from the merchant’s platform.

chainstring required

Selected chain name.

fullCurrTypestring required

Currency field that includes the chain name and corresponds to the specific currency on the specific chain.

channelIdstring required

Client Name.

Response

SUCCESS

statusstring

codestring

errorMessagestring