跳转到主要内容
GET
/
withdraw
/
open
/
institution
/
otc
/
api
/
bank
/
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>",
      "status": 1,
      "memo": "<string>"
    }
  ]
}

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.

​
概述

本页说明 GET /withdraw/open/institution/otc/api/bank/list 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

​
说明

  • 认证方式使用 GatePay 标准签名请求头。
  • 本页展示同一接口的机构路径版本。
  • 除创建子账户、查询子账户详情、分页查询子账户外，机构侧请求需携带 X-GatePay-On-Behalf-Of。
  • 通用签名规则请参见 /api-reference/version/100/cn/common/securityAndSignature。

​
补充字段说明

​
请求筛选字段

  • bankAccountName：银行账户名称，支持模糊查询
  • iban：账号或 IBAN，支持模糊查询
  • swift：SWIFT，支持模糊查询
  • bankName：银行名称，支持模糊查询

​
关键返回字段

  • data[].countryId：国家 ID
  • data[].countryName：国家名称
  • data[].address：银行地址
  • data[].remittanceLineNumber：路由或清算代码
  • data[].agentBankName：代理银行名称
  • data[].agentBankSwift：代理银行 SWIFT
  • data[].status：银行账户审核状态。1 表示通过，2 表示待审核，3 表示待补充材料，99 表示拒绝
  • data[].memo：备注。由运营人员操作时填写，通常用于审核拒绝时返回失败原因

请求头

​
X-GatePay-Certificate-ClientId
string
必填

用于标识调用应用的商户应用 ClientId。

​
X-GatePay-Signature
string
必填

按 GatePay 签名规则生成的 HMAC 签名。

​
X-GatePay-Timestamp
string
必填

用于防重放和验签的 Unix 时间戳。

​
X-GatePay-Nonce
string
必填

与时间戳配合使用的随机串，用于防止重放攻击。

​
X-GatePay-On-Behalf-Of
string
必填

必填代理归属请求头。请填写本次请求的发起方账户 ID；在机构代理商户 API 中通常填写目标子账户 ID，在机构代扣与划转接口中可填写机构账户 ID 或子账户 ID。

响应

200 - application/json

成功

​
code
string

业务响应码。

​
status
string

请求顶层状态。

​
data
object[]

已绑定银行账户列表。