v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Create a customer profile bank account

[Available in Sandbox/Production environment] Add a bank account for a customer profile

post/{customer_profile_id}/bank_accounts

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response id of Create Customer Profile API Regex: /^\s*.{1,191}\s*$/

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

account_nostring required

Bank account number Bank account length: Between 5 - 34 Regex: /^[a-zA-Z0-9\-]{5,34}$/

bankstring

Only required for FAST SG Bank account abbreviation (abbreviation) can be retrieved from Get a list of supported banks API Regex: /^\s*.{1,191}\s*$/

swift_bicstring

SWIFT code of the bank account Required field if you are doing SWIFT payments Regex: /^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/ Note: Must be uppercase

intermediary_swift_bicstring

Intermediary SWIFT code if applicable(Must be alphanumeric with 11 characters) Regex: /^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/ Note: Must be uppercase

routing_codestring

Routing code if applicable(Must be alphanumeric with maximum 31 characters) Regex: /^[A-Z0-9]{1,31}$/ Note: Must be uppercase

account_holder_namestring required

Name of bank account holder(The length must be within 191 characters) Regex: /^\s*.{1,191}\s*$/

payment_reasonstring

Payment reason is a field used to pass clear, specific instructions to the receiving bank. Length: 1 - 150 characters (Non-blank) Regex: /^\s*.{1,150}\s*$/ Note: This value will override the default Remittance Information (MT103 Field 70 / pacs.008) in the final payment message sent to the bank when provided.

Response

200

idinteger

Customer profile bank account ID.

account_nostring

Bank account number.

account_holder_namestring

Name of the bank account holder.

bank_abbrevstring

Bank abbreviation.

disabledboolean

Whether the customer profile bank account is disabled.

verification_statusstring

Customer profile bank account's verification status.

bank_account_proofstring

Bank account proof.

updated_atstring

Timestamp when the bank account was last updated.

swift_bicstring

SWIFT code of the bank account.

intermediary_swift_bicstring

Intermediary SWIFT/BIC for the bank account.

routing_codestring

Routing code for the bank account.

payment_reasonstring

Payment reason is a field used to pass clear, specific instructions to the receiving bank.

Example response

[
  {
    "id": 26513,
    "account_no": "123456792",
    "account_holder_name": "John Doe",
    "bank_abbrev": "DBS",
    "verification_status": "pending",
    "bank_account_proof": "bankAccountProofPlaceholder.png",
    "updated_at": "2025-01-17T06:26:06.659Z",
    "swift_bic": "ABCSSGSG",
    "intermediary_swift_bic": "DEFSSGSGXXX",
    "routing_code": "1231312312",
    "payment_reason": "Invoice #12345"
  }
]