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
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":["d40b4e76-909f-48a8-8fbb-106b7007dce5","fa36ee9f-6fda-45bd-bdef-75f6b7ff2c7c"],"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": [
    "d40b4e76-909f-48a8-8fbb-106b7007dce5",
    "fa36ee9f-6fda-45bd-bdef-75f6b7ff2c7c"
  ],
  "account_name": "My Savings Account",
  "account_number": "01234567",
  "sort_code": "012345"
}
Response examples (200) 
{
  "uuid": "6f574c6b-d6a7-4181-8b96-2f71e6d7b874",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "bad4eefe-72e6-47e5-a5c3-2727f9185215",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-05-29T16:20:15+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-29T16:20:15+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "sort_code": "123456",
  "created_at": "2025-05-29T16:20:15+01:00",
  "updated_at": "2025-05-29T16:20:15+01:00",
  "account_name": "Savings Account",
  "account_number": "12345678"
}