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 GET \
--url https://openplatform.gateapi.io/v1/pay/bill/orderlist \
--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>'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"merchant_id": 10002,
"total": 18,
"hasNext": true,
"nextPage": 4,
"balance_history_item_list": [
{
"transactId": "355711415868440576",
"transactTime": 1746769810346,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "-1",
"currency": "USDT",
"Balance": "934183.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411853592035330"
},
{
"transactId": "355711310076907520",
"transactTime": 1746769785136,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "+1",
"currency": "USDT",
"Balance": "934184.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411849297068033"
},
{
"transactId": "355711310076907520",
"transactTime": 1746769785131,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "-1",
"currency": "USDT",
"Balance": "934183.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411849297068033"
}
]
}
}Retrieve Transaction History
Merchants can query the transaction history of their balance accounts through this API. It supports pagination to handle large volumes of data, filtering by time range, and precise searches by financial type, order ID, currency, and other fields. This helps merchants efficiently reconcile funds and manage their finances.
curl --request GET \
--url https://openplatform.gateapi.io/v1/pay/bill/orderlist \
--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>'{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"merchant_id": 10002,
"total": 18,
"hasNext": true,
"nextPage": 4,
"balance_history_item_list": [
{
"transactId": "355711415868440576",
"transactTime": 1746769810346,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "-1",
"currency": "USDT",
"Balance": "934183.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411853592035330"
},
{
"transactId": "355711310076907520",
"transactTime": 1746769785136,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "+1",
"currency": "USDT",
"Balance": "934184.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411849297068033"
},
{
"transactId": "355711310076907520",
"transactTime": 1746769785131,
"orderId": "355450733498011648",
"merchantTradeNo": "1746707644001",
"financialType": "refund_fi",
"payAmount": "-1",
"currency": "USDT",
"Balance": "934183.9783514209",
"BalanceCurrency": "USDT",
"status": "PAID",
"payer": 10002,
"buyer": "",
"fullChain": "",
"hash": "",
"address": "TMB5f9CgcnYR365knMXKrMM6aGoYpphquj",
"payChannel": "mini_pay",
"refund_gate_id": "13411849297068033"
}
]
}
}Headers
The clientId assigned when the merchant registers an application in the Gate merchant console.
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
Request signature. GatePay uses this signature to verify whether the request is valid.
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"
Query Parameters
Start time in milliseconds
End time in milliseconds
Page number, starting from 1
Number of records per page, up to 500
Currency to search
Refers to the type of financial transaction. Includes: receipt_fi (receipt), giftCard_fi (gift card), reward_fi (reward), distribution_fi (distribution/withdrawal), refund_fi (refund), transfer_fi (transfer), convert_buy_fi (convert buy), convert_sell_fi (convert sell), convert_refund_fi (convert refund), otcRecharge_add_fi (fiat deposit), otcWithdraw_fi (fiat withdrawal), and others_fi (others).
Order type to query:1-Merchant order ID 2-GatePay order ID 3-Transaction history order ID
Order ID to query