Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of customer profile bank accounts

[Available in Sandbox/Production environment] Retrieve list of bank accounts and their verification status for a customer profile.

get/{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<br>Regex: /^\s*.{1,191}\s*$/

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> 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.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> 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.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

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 bank account is disabled.

verification_statusstring

Customer profile bank account's verification status.

swift_bicstring

SWIFT code of the bank account.

bank_account_proofstring

Bank account proof.

payment_reasonstring

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

updated_atstring

Timestamp when the bank account was last updated.

Example response

[
  {
    "id": 106766,
    "account_no": "0000011234",
    "account_holder_name": "Jane Doe",
    "bank_abbrev": "DBS",
    "verification_status": "pending",
    "bank_account_proof": "bankAccountProofPlaceholder.png",
    "payment_reason": "Invoice #12345",
    "updated_at": "2024-03-13T06:50:27.390Z"
  }
]