Getting Started
Payments
Payouts
Conversion
Gift Cards
Account & Reconciliation
Exchange Rate Query
Institution API
- POSTCreate Sub-Account
- POSTUpdate Sub-Account
- GETQuery Sub-Account
- GETList Sub-Accounts
- POSTCreate Payout (Batch Withdraw)
- POSTPayout Detail
- POSTTransfer (Institution to User)
- GETTransfer Detail (Institution to User)
- POSTCharge (User to Institution)
- GETCharge Detail (User to Institution)
- POSTCallback Notification (Sub-Account Creation Result)
- POSTQuery Account Balance
- GETGet Balance/Fund Flow Bill
- POSTCheckout Order
- POSTAddress Order
- POSTWeb / QR-Code Orders
- POSTQuery Order Details
- POSTCancel Order
- POSTCreate Refund
- GETRefund Detail
- GETQuery Supported Networks and Currencies
- POSTCreate static collection address
- GETList static collection addresses
- GETGet static collection address detail
- GETQuery static collection code bill list
- POSTCreate EVM static collection address
- DELDelete static collection address
- POSTCreate Convert
- GETQuery Available Convert Currencies
- GETQuery Available Convert Pairs
- POSTConvert Preview
- GETQuery Convert Order
curl --request POST \
--url https://openplatform.gateapi.io/payment/open/institution/v1/pay/transactions/native \
--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 '
{
"merchantTradeNo": "118223456797",
"env": {
"terminalType": "APP"
},
"goods": {
"goodsName": "NF2T",
"goodsDetail": "nef-book"
}
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "50984376880599040",
"terminalType": "APP",
"expireTime": 1674118228000,
"location": "https://www.gate.io/webpay?prepayid=55583289224171652",
"qrContent": "http://openplatform.gate.io/qr/amaA9duknMfGKvM5H77Q0STgoTgVPmbPyuPDzlFvJO8="
}
}Web / QR-Code Orders
Create a Web or scan-code pending payment order on behalf of a sub-account. Returns prepay ID, QR content, and Web payment redirect URL.
curl --request POST \
--url https://openplatform.gateapi.io/payment/open/institution/v1/pay/transactions/native \
--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 '
{
"merchantTradeNo": "118223456797",
"env": {
"terminalType": "APP"
},
"goods": {
"goodsName": "NF2T",
"goodsDetail": "nef-book"
}
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "50984376880599040",
"terminalType": "APP",
"expireTime": 1674118228000,
"location": "https://www.gate.io/webpay?prepayid=55583289224171652",
"qrContent": "http://openplatform.gate.io/qr/amaA9duknMfGKvM5H77Q0STgoTgVPmbPyuPDzlFvJO8="
}
}Headers
The clientId assigned when the merchant registers an application in the Gate merchant console.
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.
"1672905655498"
Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.
"9578"
Request signature. GatePay uses this signature to verify whether the request is valid.
The institution account id being acted on behalf of (sub-account ID).
"2124538349"
Body
Merchant order number, max 32 bytes.
Transaction source: APP, WEB, WAP, MINIAPP, OTHERS.
Show child attributes
Show child attributes
Goods description.
Show child attributes
Show child attributes
Crypto currency, uppercase (e.g. USDT, BTC).
Crypto order amount; min 0.000001, 6 decimals; range [0.0001, 500000].
Fiat currency.
Fiat order amount.
Settlement currency if different from order currency.
Order expiry, UTC milliseconds; default 1 hour, max 1 hour.
Redirect URL after success, max 256 chars.
Redirect URL after cancel, max 256 chars.
Client/channel name.