Skip to content
aimrack

Customer Bank Account

The customer bank account resource.

Base/customerBankAccount
GET/customerBankAccount

List customer bank accounts

Retrieve a paginated list of customer bank accounts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/customerBankAccount
curl --request GET \
  --url '<your-host>/customerBankAccount?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "customerId": "xyz789",
    "name": "Example",
    "isPrimary": true,
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/customerBankAccount

Retrieve a customer bank account

Fetch a single customer bank account by filtering on `id`.

Query parameters

idstring

Match on the customer bank account's `id`, e.g. `eq.{id}`.

GET/customerBankAccount
curl --request GET \
  --url '<your-host>/customerBankAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "name": "Example",
  "isPrimary": true,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/customerBankAccount

Create a customer bank account

Create a new customer bank account.

Body parameters

customerIdstringrequired
namestringrequired
accountHolderNamestring
bankNamestring
bankAddressstring
countryCodestring

References country.alpha2

currencyCodestring
accountNumberstring
bankCodestring
swiftBicstring
isPrimarybooleanrequired
activebooleanrequired
notesstring
customFieldsobject
tagsarray
POST/customerBankAccount
curl --request POST \
  --url <your-host>/customerBankAccount \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789","name":"Example","isPrimary":true,"active":true}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "name": "Example",
  "isPrimary": true,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/customerBankAccount

Update a customer bank account

Update an existing customer bank account, matched on `id`.

Body parameters

customerIdstringrequired
namestringrequired
accountHolderNamestring
bankNamestring
bankAddressstring
countryCodestring

References country.alpha2

currencyCodestring
accountNumberstring
bankCodestring
swiftBicstring
isPrimarybooleanrequired
activebooleanrequired
notesstring
customFieldsobject
tagsarray
PATCH/customerBankAccount
curl --request PATCH \
  --url '<your-host>/customerBankAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "name": "Example",
  "isPrimary": true,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/customerBankAccount

Delete a customer bank account

Delete a customer bank account, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the customer bank account to delete, e.g. `eq.{id}`.

DELETE/customerBankAccount
curl --request DELETE \
  --url '<your-host>/customerBankAccount?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content