跳转到主要内容
POST
Update Bank Account

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起该请求。应设置为 account_id,可通过 List Connected Accounts 获取。若省略或为空,则使用主账户执行请求。 更多信息见 Connected Accounts

x-idempotency-key
string<uuid>
必填

用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

路径参数

id
string<uuid>
必填

银行账户的唯一标识符(UUID)。

示例:

"a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345"

请求体

application/json

请求与响应之间共享的通用银行账户属性。

account_number
string
必填

银行账号(例如 IBAN)。

Required string length: 5 - 60
示例:

"GB71950018692652646598"

bank_name
string
必填

银行名称。

示例:

"DBS Bank"

swift_code
string
必填

银行的 SWIFT/BIC 代码。

Required string length: 8 - 11
示例:

"DBSSSGSG"

bank_country_code
string<iso-3166-1-alpha-2>
必填

银行所在国家的两字母代码(ISO 3166-1 alpha-2)。

Required string length: 2
示例:

"SG"

bank_address
string
必填

银行的实际地址。

示例:

"12 Marina Boulevard, Singapore 018982"

bank_code_type
enum<string>

银行路由代码的类型。根据币种和国家要求填写:

  • aba - 当 currency = "USD" 且 bank_country_code = "US" 时必填
  • bank_code - 当 currency = "CAD" 或 currency = "HKD" 时必填
  • sort_code - 当 currency = "GBP" 时必填
  • bsb_code - 当 currency = "AUD" 时必填
  • ifsc - 当 currency = "INR" 时必填
  • cnaps_number - 当 currency = "CNH" 且 bank_country_code = "CN" 时必填
可用选项:
aba,
bank_code,
sort_code,
bsb_code,
ifsc,
cnaps_number
示例:

"aba"

bank_code_value
string

银行标识值。所需格式取决于所选的 bank_code_type

bank_code_type 接受的格式:

  • aba:恰好 9 位数字。
  • bank_code:恰好 3 位数字。
  • sort_code:恰好 6 位数字。
  • bsb_code:恰好 6 位数字。
  • ifsc:恰好 11 个字符,格式为:
    • 前 4 个字符:字母(A–Z)
    • 第 5 个字符:数字 0
    • 后 6 个字符:字母(A–Z)或数字(0–9)
  • cnaps_number:恰好 12 位数字。
示例:

"021000021"

bank_branch_code
string

银行分行代码。当 currency = "CAD" 时必填。

示例:

"00001"

响应

200 - application/json

成功更新银行账户

请求与响应之间共享的通用银行账户属性。

account_number
string

银行账号(例如 IBAN)。

Required string length: 5 - 60
示例:

"GB71950018692652646598"

bank_name
string

银行名称。

示例:

"DBS Bank"

swift_code
string

银行的 SWIFT/BIC 代码。

Required string length: 8 - 11
示例:

"DBSSSGSG"

bank_country_code
string<iso-3166-1-alpha-2>

银行所在国家的两字母代码(ISO 3166-1 alpha-2)。

Required string length: 2
示例:

"SG"

bank_address
string

银行的实际地址。

示例:

"12 Marina Boulevard, Singapore 018982"

bank_code_type
enum<string>

银行路由代码的类型。根据币种和国家要求填写:

  • aba - 当 currency = "USD" 且 bank_country_code = "US" 时必填
  • bank_code - 当 currency = "CAD" 或 currency = "HKD" 时必填
  • sort_code - 当 currency = "GBP" 时必填
  • bsb_code - 当 currency = "AUD" 时必填
  • ifsc - 当 currency = "INR" 时必填
  • cnaps_number - 当 currency = "CNH" 且 bank_country_code = "CN" 时必填
可用选项:
aba,
bank_code,
sort_code,
bsb_code,
ifsc,
cnaps_number
示例:

"aba"

bank_code_value
string

银行标识值。所需格式取决于所选的 bank_code_type

bank_code_type 接受的格式:

  • aba:恰好 9 位数字。
  • bank_code:恰好 3 位数字。
  • sort_code:恰好 6 位数字。
  • bsb_code:恰好 6 位数字。
  • ifsc:恰好 11 个字符,格式为:
    • 前 4 个字符:字母(A–Z)
    • 第 5 个字符:数字 0
    • 后 6 个字符:字母(A–Z)或数字(0–9)
  • cnaps_number:恰好 12 位数字。
示例:

"021000021"

bank_branch_code
string

银行分行代码。当 currency = "CAD" 时必填。

示例:

"00001"

id
string

银行账户的唯一标识符(UUID)。

示例:

"a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345"

account_name
string

账户持有人姓名。

示例:

"UQPAY PTE. LTD."

currency
string

结算账户的币种。

示例:

"SGD"

account_status
enum<string>

银行账户的状态。

  • Valid:银行账户有效,可用于结算。
  • Invalid:银行账户无效,不可用于结算。
可用选项:
Valid,
Invalid
示例:

"Valid"