Skip to main content
GET
Get cash account by id

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"3e25a086-b75e-4736-a42f-6a57338c4ec7"

Path Parameters

accountId
string<uuid>
required

Must equal CashAccount.id from the list endpoint.

Response

One cash account (same schema as list item)

A single cash account with bank details and cards (account type is implied by the cash-accounts API surface)

id
string<uuid>
required

Unique identifier of the cash account

Example:

"b2c3d4e5-f6a7-8901-bcde-f12345678901"

currency
string
required

ISO 4217 currency code (e.g. GBP, EUR, AUD, DKK)

Example:

"GBP"

status
enum<string>

Cash account status

Available options:
Active,
ReceiveOnly,
SpendOnly,
Suspended,
Blocked
Example:

"Active"

bankAccount
object

Bank account linked to this cash account

cards
object[]

Payment cards linked to this cash account