Bank Accounts

The bank account object represents bank account details used for disbursements. This object is used when creating recipients for transfers or transfer schedules.

Overview

Bank accounts are not created directly through the API. Instead, they are created as part of:

• Creating a Recipient - Provide bank account details when creating a recipient
• Updating a Recipient - Update bank account information for an existing recipient

Object Structure

Attribute	Type	Description
object	string	Always bank_account
livemode	boolean	Whether this is a live or test mode object
brand	string	Bank name (e.g., "Bangkok Bank", "Kasikorn Bank")
bank_code	string	Bank identifier code
branch_code	string	Branch code (required for Japan)
account_number	string	Full account number (masked in responses)
last_digits	string	Last 4 digits of the account number
name	string	Account holder name
type	string	Account type: normal or current (Japan only)
created_at	string	ISO 8601 creation timestamp

Example Response

{
  "object": "bank_account",
  "livemode": false,
  "brand": "Bangkok Bank",
  "bank_code": "bbl",
  "branch_code": null,
  "account_number": "",
  "last_digits": "6789",
  "name": "John Doe",
  "type": null,
  "created_at": "2024-01-15T10:30:00Z"
}

Supported Banks

Bank codes vary by country. Use the Capability API to retrieve the list of supported banks for your account's country.

Thailand

Common bank codes include: bbl (Bangkok Bank), kbank (Kasikorn Bank), scb (Siam Commercial Bank), ktb (Krungthai Bank), and more.

Japan

Requires branch_code and type (normal/current) in addition to standard fields.

Singapore, Malaysia, Indonesia

Each country has its own set of supported bank codes available through the Capability API.

Related Endpoints

• Create Recipient - Create a recipient with bank account
• Update Recipient - Update recipient's bank account
• Create Transfer - Transfer funds to a recipient's bank account
• Retrieve Capability - Get supported banks list