Funds Ledger

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>'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist"

headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>'
  }
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'

response = http.request(request)
puts response.read_body

{
  "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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"
      }
    ]
  }
}

GET

payment

open

institution

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>'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist"

headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>'
  }
};

fetch('https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/payment/open/institution/v1/pay/bill/orderlist")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'

response = http.request(request)
puts response.read_body

{
  "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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",
        "originalOrderId": "355400733498011600",
        "originalMerchantTradeNo": "1746707600001",
        "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"
      }
    ]
  }
}

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

Authentication uses the standard GatePay signed headers.
This page documents the standard merchant endpoint.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

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

Millisecond timestamp; the difference from server time must not exceed 30 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), refund_to_merchant_fi (merchant 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

transactionType

integer

Transaction type: 1-Income 2-Expense

timeType

integer<int64>

Time query type: 1-Creation time 2-Refund fund time

status

string

Refund status: SUCCESS-Success FAIL-Failure

sortType

string

Sort order: pay_time_desc-Descending by posting time, pay_time_asc-Ascending by posting time. Default: pay_time_desc

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

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Headers

Query Parameters

Response

​Overview

​Notes

Headers

Query Parameters

Response

Overview

Notes