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/v1/pay/address/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"merchantTradeNo": "93840202212210025",
"env": {
"terminalType": "MINIAPP"
},
"goods": {
"goodsName": "USDT_PAY_BTC_TEST",
"goodsDetail": "yc"
},
"orderExpireTime": 1673410179000,
"merchantUserId": 1336974,
"chain": "BSC",
"fullCurrType": "BTC_BSC",
"channelId": "123456"
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "47656656276819968",
"terminalType": "MINIAPP",
"expireTime": 1673410179000,
"chain": {
"chain_type": "BSC",
"fullCurrType": "USDT_BSC",
"address": "0x1699dB45Dc502A0395038265fCBC4Fa05d6afFBD"
}
}
}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.
curl --request POST \
--url https://openplatform.gateapi.io/v1/pay/address/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"merchantTradeNo": "93840202212210025",
"env": {
"terminalType": "MINIAPP"
},
"goods": {
"goodsName": "USDT_PAY_BTC_TEST",
"goodsDetail": "yc"
},
"orderExpireTime": 1673410179000,
"merchantUserId": 1336974,
"chain": "BSC",
"fullCurrType": "BTC_BSC",
"channelId": "123456"
}
'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"prepayId": "47656656276819968",
"terminalType": "MINIAPP",
"expireTime": 1673410179000,
"chain": {
"chain_type": "BSC",
"fullCurrType": "USDT_BSC",
"address": "0x1699dB45Dc502A0395038265fCBC4Fa05d6afFBD"
}
}
}Headers
Merchant client ID, obtained from GatePay platform
HMAC-SHA256 signature for request validation
Timestamp in milliseconds, must not differ from server time by more than 5 minutes
Random nonce for replay attack prevention
Body
Request for creating a payment order.
Merchant transaction ID in the merchant's system.
Transaction source, optional values: APP, WEB, WAP, MINIAPP, OTHERS.
Show child attributes
Show child attributes
Goods.
Show child attributes
Show child attributes
Merchant-specified expiration time of the order, in milliseconds.
Unique consumer ID from the merchant’s platform.
Selected chain name.
Currency field that includes the chain name and corresponds to the specific currency on the specific chain.
Client Name.
Crypto order currency.
Crypto order amount.
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.
Fiat order currency in uppercase form, such as EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF.
Fiat order amount, with a maximum precision of 2 digits.
Surcharge, a fee borne by the consumer.
User-selected payment currency, not required for non-flash payment orders.
Callback URL for payment completion.
Callback URL for payment cancellation.