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/checkout/order \
--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": "163",
"env": {
"terminalType": "APP"
},
"currency": "USDT",
"orderAmount": "118.75",
"merchantUserId": 123,
"goods": {
"goodsType": "02",
"goodsName": "Sipariş Ödemesi - 177",
"goodsDetail": "Sipariş No : 160"
},
"chain": "MATIC",
"fullCurrType": "USDT_MATIC"
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "65466648727916544",
"fiatCurrency": "",
"fiatAmount": "",
"currency": "USDT",
"terminalType": "APP",
"expireTime": 1677573665219,
"qrContent": "http://openplatform.gate.io/qr/GA0cskPehKxQpshvm3Goeve8dHpwCl6yCHLSWUYrLqo=",
"location": "https://www.gate.com/cashier?prepayid=65466648727916544",
"payCurrency": "USDT",
"payAmount": "118.75",
"chain": {
"chain_type": "BSC",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"fullCurrType": "USDT_EOS"
},
"channelId": "123456",
"goodsName": "Sipariş Ödemesi - 177",
"inUsdt": "118.75"
}
}Checkout Order
Create a cashier (checkout) order on behalf of a sub-account. Returns prepay ID, cashier URL, QR content, and chain/address info for the user to complete payment.
curl --request POST \
--url https://openplatform.gateapi.io/payment/open/institution/v1/pay/checkout/order \
--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": "163",
"env": {
"terminalType": "APP"
},
"currency": "USDT",
"orderAmount": "118.75",
"merchantUserId": 123,
"goods": {
"goodsType": "02",
"goodsName": "Sipariş Ödemesi - 177",
"goodsDetail": "Sipariş No : 160"
},
"chain": "MATIC",
"fullCurrType": "USDT_MATIC"
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "65466648727916544",
"fiatCurrency": "",
"fiatAmount": "",
"currency": "USDT",
"terminalType": "APP",
"expireTime": 1677573665219,
"qrContent": "http://openplatform.gate.io/qr/GA0cskPehKxQpshvm3Goeve8dHpwCl6yCHLSWUYrLqo=",
"location": "https://www.gate.com/cashier?prepayid=65466648727916544",
"payCurrency": "USDT",
"payAmount": "118.75",
"chain": {
"chain_type": "BSC",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"fullCurrType": "USDT_EOS"
},
"channelId": "123456",
"goodsName": "Sipariş Ödemesi - 177",
"inUsdt": "118.75"
}
}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.
Order currency, uppercase (e.g. USDT, BTC).
Order amount; min 0.000001, up to 6 decimal places.
Transaction source.
Show child attributes
Show child attributes
Goods description.
Show child attributes
Show child attributes
Payer's unique ID on the merchant platform.
Chain name; obtain from /v1/pay/address/chains.
Currency field including chain name, mapping to specific chain/currency.
Surcharge borne by the consumer.
Tolerance: when remaining amount ≤ this value, payment is considered complete.
Fiat currency, uppercase (e.g. EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF).
Fiat order amount; min 0.01, up to 2 decimal places.
Payment currency for address payment; defaults to currency if omitted.
Order expiry time, milliseconds. Default 1 hour, max 1 hour.
Redirect URL after successful payment, max 256 chars.
Redirect URL after failed/cancelled payment, max 256 chars.
Client/channel name.