v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Update virtual bank account status

[Available in Sandbox environment only] Simulates bank account verification for a given bank account

put/sandbox/customer_profile/{customer_profile_id}/virtual_bank_accounts/{virtual_bank_account_id}

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*$/

virtual_bank_account_idstring required

Virtual Bank Account ID is retrieved from the response id of Create Virtual Bank Account 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

statusstring required

Accepts only enabled or disabled

Response

200

Example response

{
  "data": {
    "id": "StraitsX-2370-5220e519-7f2f-4f05-950b-4a42498d338b",
    "type": "virtual_bank_account",
    "attributes": {
      "referenceId": "a68970c7-ebc5-45aa-b0ac-abb51558e590",
      "currency": "USD",
      "status": "enabled",
      "instructions": {
        "recipientName": "John Doe",
        "bankName": "DBS Bank",
        "bankAddress": "12 Marina Boulevard, DBS Asia Central, Marina Bay Financial Centre Tower 3, Singapore 018982",
        "bankCountry": "Singapore",
        "swiftBic": "DBSSSGSGXXX",
        "accountNo": "8859300021564334"
      }
    }
  }
}