Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
bill
/
orderlist
Retrieve transaction history
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"
      },
      {
        "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"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This page documents the GET /payment/open/institution/v1/pay/bill/orderlist endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

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-Signature
string
required

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

​
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-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Query Parameters

​
startTime
integer<int64>
required

Start time in milliseconds

​
endTime
integer<int64>
required

End time in milliseconds

​
page
integer
required

Page number, starting from 1

​
count
integer
required

Number of records per page, up to 500

​
currency
string

Currency to search

​
financialType
string

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).

​
orderType
integer

Order type to query:1-Merchant order ID 2-GatePay order ID 3-Transaction history order ID

​
orderIdNo
string

Order ID to query

Response

200 - application/json

Success

​
status
enum<string>
required

API response result, SUCCESS or FAIL.

Available options:
SUCCESS,
FAIL
​
code
string
required

Response error code.

​
errorMessage
string

Error description.

​
data
object