Skip to main content
GET
/
withdraw
/
open
/
institution
/
otc
/
api
/
bank
/
list
Query Bank Account List
curl --request GET \
  --url https://openplatform.gateapi.io/withdraw/open/institution/otc/api/bank/list \
  --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>'
{
  "code": "<string>",
  "status": "<string>",
  "data": [
    {
      "bankAccountId": "<string>",
      "bankAccountName": "<string>",
      "bankName": "<string>",
      "countryId": 123,
      "countryName": "<string>",
      "address": "<string>",
      "iban": "<string>",
      "swift": "<string>",
      "remittanceLineNumber": "<string>",
      "agentBankName": "<string>",
      "agentBankSwift": "<string>",
      "memo": "<string>"
    }
  ]
}

​
Overview

This page documents the GET /withdraw/open/institution/otc/api/bank/list 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 institution-path version of the same endpoint.
  • Except for create sub-account, query sub-account detail, and list sub-accounts, institution requests must include X-GatePay-On-Behalf-Of.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

​
Supplemental Field Notes

​
Request Filters

  • bankAccountName: bank account name, supports fuzzy matching
  • iban: account number or IBAN, supports fuzzy matching
  • swift: SWIFT code, supports fuzzy matching
  • bankName: bank name, supports fuzzy matching

​
Key Response Fields

  • data[].countryId: country ID
  • data[].countryName: country name
  • data[].address: bank address
  • data[].remittanceLineNumber: routing or clearing code
  • data[].agentBankName: agent bank name
  • data[].agentBankSwift: agent bank SWIFT
  • data[].status: bank account review status. 1 = approved, 2 = pending review, 3 = pending supplementary materials, 99 = rejected
  • data[].memo: memo entered by operations staff, typically returned as the rejection reason when the bank account review is rejected

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant application client ID used to identify the calling app.

​
X-GatePay-Signature
string
required

HMAC signature generated from the request according to GatePay signing rules.

​
X-GatePay-Timestamp
string
required

Unix timestamp used for replay protection and signature verification.

​
X-GatePay-Nonce
string
required

Random nonce used together with the timestamp to prevent replay attacks.

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

Response

200 - application/json

Success

​
code
string

Business response code.

​
status
string

Top-level request status.

​
data
object[]

Linked bank account list.