Create a bank account

POST /api/v2/bank-accounts

Personal access token & O auth2

Headers

application/json

Body Required

account_uuids array[string] Required

The UUIDs of the accounts who should own the bank account. These must only be client accounts.
account_name string Required

The friendly name for the bank account.
account_number string Required

The bank account number.
sort_code string Required

The bank account sort code

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- account_name string
  
  The name of the bank account
- account_number string
  
  The bank account number
- sort_code string
  
  The bank account sort code
- accounts object
  
  The accounts linked to this bank account

POST /api/v2/bank-accounts

curl \
 --request POST 'https://api.plannrcrm.com/api/v2/bank-accounts' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuids":["58cccd10-6f2c-4c1e-a9f9-17a161734285","3aaa3165-859a-4fcc-9d5f-a00d77d27452"],"account_name":"My Savings Account","account_number":"01234567","sort_code":"012345"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "58cccd10-6f2c-4c1e-a9f9-17a161734285",
    "3aaa3165-859a-4fcc-9d5f-a00d77d27452"
  ],
  "account_name": "My Savings Account",
  "account_number": "01234567",
  "sort_code": "012345"
}

Response examples (200)

{
  "uuid": "1a480d2f-6071-4b0a-800c-53a1c868490e",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "f90ded28-9198-4a9c-a20b-3f40b44b5d53",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-20T18:21:29+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-20T18:21:29+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "sort_code": "123456",
  "created_at": "2025-06-20T18:21:29+01:00",
  "updated_at": "2025-06-20T18:21:29+01:00",
  "account_name": "Savings Account",
  "account_number": "12345678"
}