Bank Accounts#

Bank Account objects represent destination bank accounts for payouts.

The Bank Account object#

Attribute	Type	Description
`id`	string	Unique identifier with `ba_` prefix
`object`	string	Always `"bank_account"`
`account_holder_name`	string	Name on the account
`account_holder_type`	enum	`individual` or `company`
`bank_name`	string	Name of the bank
`country`	string	Country code
`currency`	string	Account currency
`last4`	string	Last 4 digits of account number
`sort_code`	string	Sort code (UK)
`routing_number`	string	Routing number (US)
`status`	enum	`new`, `validated`, `verified`, `errored`
`default_for_currency`	boolean	Default for this currency
`metadata`	hash	Key-value pairs
`created`	timestamp	Time at which the object was created

{
  "id": "ba_abc123",
  "object": "bank_account",
  "account_holder_name": "Property Management Ltd",
  "account_holder_type": "company",
  "bank_name": "HSBC",
  "country": "GB",
  "currency": "gbp",
  "last4": "2345",
  "sort_code": "108800",
  "status": "verified",
  "default_for_currency": true,
  "created": 1706140800
}

Create a Bank Account#

POST /v1/bank_accounts

Parameter	Type	Required	Description
`account_holder_name`	string	Yes	Name on the account
`account_holder_type`	string	No	`individual` or `company`
`account_number`	string	Yes	Full account number
`sort_code`	string	Conditional	Sort code (UK)
`routing_number`	string	Conditional	Routing number (US)
`iban`	string	Conditional	IBAN (EU)
`currency`	string	Yes	Account currency
`country`	string	Yes	Country code

curl https://api.casapay.com/v1/bank_accounts \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "account_holder_name": "Property Management Ltd",
    "account_holder_type": "company",
    "account_number": "00012345",
    "sort_code": "108800",
    "currency": "gbp",
    "country": "GB"
  }'

Retrieve, Update, Delete, List#

GET /v1/bank_accounts/:id

POST /v1/bank_accounts/:id

DELETE /v1/bank_accounts/:id

GET /v1/bank_accounts