Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Bank Accounts

Create Bank Account

Create a new bank account for settlement purposes.

post/v2/payment/bankaccount/create

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Request body

account_numberstring required

Bank account number (e.g., IBAN).

bank_namestring required

Name of the bank.

swift_codestring required

SWIFT/BIC code of the bank.

bank_country_codestring iso-3166-1-alpha-2 required

Two-letter country code (ISO 3166-1 alpha-2) of the bank.

bank_addressstring required

Physical address of the bank.

bank_code_type'aba' | 'bank_code' | 'sort_code' | 'bsb_code' | 'ifsc' | 'cnaps_number'

Type of bank routing code. Required based on currency and country:

  • aba - Required when currency = "USD" and bank_country_code = "US"
  • bank_code - Required when currency = "CAD" or currency = "HKD"
  • sort_code - Required when currency = "GBP"
  • bsb_code - Required when currency = "AUD"
  • ifsc - Required when currency = "INR"
  • cnaps_number - Required when currency = "CNH" and bank_country_code = "CN"
bank_code_valuestring

The bank identifier value. The required format depends on the selected bank_code_type.

Accepted formats by bank_code_type:

  • aba: Exactly 9 digits.
  • bank_code: Exactly 3 digits.
  • sort_code: Exactly 6 digits.
  • bsb_code: Exactly 6 digits.
  • ifsc: Exactly 11 characters in the format:
    • First 4 characters: letters (A–Z)
    • 5th character: the digit 0
    • Last 6 characters: letters (A–Z) or digits (0–9)
  • cnaps_number: Exactly 12 digits.
bank_branch_codestring

Bank branch code. Required when currency = "CAD".

currencystring required

Three-letter currency code

Example request

{
  "account_number": "GB71950018692652646598",
  "bank_name": "DBS Bank",
  "swift_code": "DBSSSGSG",
  "bank_country_code": "SG",
  "bank_address": "12 Marina Boulevard, Singapore 018982",
  "bank_code_type": "aba",
  "bank_code_value": "021000021",
  "bank_branch_code": "00001"
}

Response

Bank account created successfully

account_numberstring

Bank account number (e.g., IBAN).

bank_namestring

Name of the bank.

swift_codestring

SWIFT/BIC code of the bank.

bank_country_codestring iso-3166-1-alpha-2

Two-letter country code (ISO 3166-1 alpha-2) of the bank.

bank_addressstring

Physical address of the bank.

bank_code_type'aba' | 'bank_code' | 'sort_code' | 'bsb_code' | 'ifsc' | 'cnaps_number'

Type of bank routing code. Required based on currency and country:

  • aba - Required when currency = "USD" and bank_country_code = "US"
  • bank_code - Required when currency = "CAD" or currency = "HKD"
  • sort_code - Required when currency = "GBP"
  • bsb_code - Required when currency = "AUD"
  • ifsc - Required when currency = "INR"
  • cnaps_number - Required when currency = "CNH" and bank_country_code = "CN"
bank_code_valuestring

The bank identifier value. The required format depends on the selected bank_code_type.

Accepted formats by bank_code_type:

  • aba: Exactly 9 digits.
  • bank_code: Exactly 3 digits.
  • sort_code: Exactly 6 digits.
  • bsb_code: Exactly 6 digits.
  • ifsc: Exactly 11 characters in the format:
    • First 4 characters: letters (A–Z)
    • 5th character: the digit 0
    • Last 6 characters: letters (A–Z) or digits (0–9)
  • cnaps_number: Exactly 12 digits.
bank_branch_codestring

Bank branch code. Required when currency = "CAD".

idstring

Unique identifier (UUID) of the bank account.

account_namestring

Name of the account holder.

currencystring

Three-letter currency code

account_status'Valid' | 'Invalid'

Status of the bank account.

  • Valid: The bank account is active and can be used for settlements.
  • Invalid: The bank account is inactive and cannot be used for settlements.

Example response

{
  "account_number": "GB71950018692652646598",
  "bank_name": "DBS Bank",
  "swift_code": "DBSSSGSG",
  "bank_country_code": "SG",
  "bank_address": "12 Marina Boulevard, Singapore 018982",
  "bank_code_type": "aba",
  "bank_code_value": "021000021",
  "bank_branch_code": "00001",
  "id": "a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345",
  "account_name": "UQPAY PTE. LTD.",
  "account_status": "Valid"
}