Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
bill
/
orderlist
Get balance/fund flow bill
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist \
  --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>'
{
  "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"
      }
    ]
  }
}

Headers

​
X-GatePay-Certificate-ClientId
string
required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

​
X-GatePay-Signature
string
required

Request signature. GatePay uses this signature to verify whether the request is valid.

​
X-GatePay-On-Behalf-Of
string
required

The institution account id being acted on behalf of (sub-account ID).

Example:

"2124538349"

Query Parameters

​
startTime
integer<int64>
required

Start time, in milliseconds.

Example:

1746758276000

​
endTime
integer<int64>
required

End time, in milliseconds.

Example:

1746772913000

​
page
integer
required

Page number, starting from 1.

Example:

3

​
count
integer
required

Number of items per page, max 500.

Example:

3

​
currency
string

Filter by currency.

Example:

"USDT"

​
financialType
string

Financial type (e.g. receipt_fi, payment_fi, giftCard_fi, reward_fi, distribution_fi, refund_fi, transfer_fi, c2cTransfer_fi, convert_buy_fi, convert_sell_fi, convert_refund_fi, otcRecharge_add_fi, otcWithdraw_fi, others_fi).

​
orderType
integer

Order query type: 1-merchant order no., 2-GatePay order no., 3-fund flow order no.

​
orderIdNo
string

Order or query ID.

Response

200 - application/json

Success

​
status
string
​
code
string
​
errorMessage
string
​
data
object