Accounts
An account represents a bank account, or virtual wallet of some kind, capable of holding a sum of transactions.
Last updated
An account represents a bank account, or virtual wallet of some kind, capable of holding a sum of transactions.
Last updated
name
An account name of your choice.
visibility
currency
externalId
An external ID to tie this account with a resource from your side.
createdAt
updatedAt
You cannot change an account's currencyCode
once created.
When deleting an account, you will first receive a 412 Precondition Failed
response. You should then take the Last-Modified
header included with the error response, set it as the If-Unmodified-Since
request header & repeat the request.
On successful delete, you'll receive a 204 No Content
response.
If you receive a 412 Precondition Failed
response again, use the new Last-Modified
header received & repeat.
root
accountOne of "PUBLIC
", "PRIVATE
" or "UNLISTED
" - see .
A for this account.
The timestamp (UTC) () when the account was created.
The timestamp (UTC) () when the account was updated.
The root
account for Testbank is special. You can from the root account to generate a balance to play with, or you can to the root account to clear your account out.
List all accounts.
Filter all accounts where the name contains a specific substring.
My Account
Filter all accounts where the currency matches a specific Currency Code.
UNLISTED
Example: PUBLIC
Possible values: Filter all accounts where the currency matches a specific Currency Code.
USD
Filter all accounts where the externalId matches a specific string.
cb8ff63f-cb92-4328-b3c7-b54e2b6dbc5f
Set the page number of resources to return.
1
Set the maximum number of resources to return.
20
Get a specific account by ID.
Account ID
a1b2c3d4e5
Delete an account & all data related to the account. Please note: This may not delete all account & transaction data - other accounts' transactions will retain the account ID. All other attributes will cleared.
Account ID
a1b2c3d4e5
A Last-Modified
header from a previous response to this endpoint. If the Last Modified date of the resource matches this value, then the resource will be successfully deleted.
Tue, 03 May 2022 10:00:00 GMT
No content
Create a new account, with a name, visibility & currency. Optionally include an external ID so you can tie this account with a resource from your side. Optionally include an initial transaction to set the opening balance.
Update an account's name, visibility & external ID. You cannot change an account's currency once opened.
Account ID
a1b2c3d4e5