Accounts

An account represents a bank account, or virtual wallet of some kind, capable of holding a sum of transactions.

Attribute	Description
name	An account name of your choice.
visibility	One of "PUBLIC", "PRIVATE" or "UNLISTED" - see Discovery.

Relationship	Description
currency	A supported currency for this account.

Meta	Description
externalId	An external ID to tie this account with a resource from your side.
createdAt	The timestamp (UTC) (ISO8601) when the account was created.
updatedAt	The timestamp (UTC) (ISO8601) when the account was updated.

---

List accounts

List all accounts.

GEThttps://api.testbank.dev/accounts

Query parameters

Response

200401403500

List of Accounts

Body

application/json

data*array of AccountResource

meta*JsonApiPrimaryDataPaginationLinks (object)

A JSON:API-formatted object detailing further links, including pagination.

Request

JavaScriptCurl

const response = await fetch('https://api.testbank.dev/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "accounts",
      "id": "a1b2c3d4e5",
      "attributes": {
        "name": "My Account",
        "visibility": "PUBLIC"
      },
      "relationships": {
        "currency": {
          "data": {
            "type": "currencies",
            "id": "USD"
          }
        }
      },
      "meta": {
        "externalId": "cb8ff63f-cb92-4328-b3c7-b54e2b6dbc5f",
        "balanceTotal": "100.00",
        "createdAt": "2023-07-12T19:00:00.000Z",
        "updatedAt": "2023-07-12T19:00:00.000Z"
      }
    }
  ],
  "meta": {
    "prev": "/resource?page[count]=2&page[limit]=100",
    "next": "/resource?page[count]=4&page[limit]=100",
    "first": "/resource?page[count]=1&page[limit]=100",
    "last": "/resource?page[count]=10&page[limit]=100"
  }
}

---

Create account

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.

POSThttps://api.testbank.dev/accounts

Body

application/json

data*object

Response

200401403404500

Created account

Body

application/json

data*object

Request

JavaScriptCurl

const response = await fetch('https://api.testbank.dev/accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "type": "accounts",
        "attributes": {
          "name": "My Account"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "type": "accounts",
    "id": "a1b2c3d4e5",
    "attributes": {
      "name": "My Account",
      "visibility": "PUBLIC"
    },
    "relationships": {
      "currency": {
        "data": {
          "type": "currencies",
          "id": "USD"
        }
      },
      "initialTransaction": {
        "data": {
          "type": "transactions",
          "id": "c3d4e5f6g7"
        }
      }
    },
    "meta": {
      "externalId": "cb8ff63f-cb92-4328-b3c7-b54e2b6dbc5f",
      "balanceTotal": "100.00",
      "createdAt": "2023-07-12T19:00:00.000Z",
      "updatedAt": "2023-07-12T19:00:00.000Z"
    }
  }
}

• You cannot change an account's currencyCode once created.

---

Get account by ID

Get a specific account by ID.

GEThttps://api.testbank.dev/accounts/{accountId}

Path parameters

accountId*string

Account ID

Example: "a1b2c3d4e5"

Response

200401403404500

Found account.

Body

application/json

data*AccountResource

Request

JavaScriptCurl

const response = await fetch('https://api.testbank.dev/accounts/{accountId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "type": "accounts",
    "id": "a1b2c3d4e5",
    "attributes": {
      "name": "My Account",
      "visibility": "PUBLIC"
    },
    "relationships": {
      "currency": {
        "data": {
          "type": "currencies",
          "id": "USD"
        }
      }
    },
    "meta": {
      "externalId": "cb8ff63f-cb92-4328-b3c7-b54e2b6dbc5f",
      "balanceTotal": "100.00",
      "createdAt": "2023-07-12T19:00:00.000Z",
      "updatedAt": "2023-07-12T19:00:00.000Z"
    }
  }
}

---

Update account

Update an account's name, visibility & external ID. You cannot change an account's currency once opened.

PATCHhttps://api.testbank.dev/accounts/{accountId}

Body

application/json

data*object

Response

200401403404500

Updated account

Body

application/json

data*AccountResource

Request

JavaScriptCurl

const response = await fetch('https://api.testbank.dev/accounts/{accountId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "type": "accounts",
        "attributes": {
          "name": "My Account"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "data": {
    "type": "accounts",
    "id": "a1b2c3d4e5",
    "attributes": {
      "name": "My Account",
      "visibility": "PUBLIC"
    },
    "relationships": {
      "currency": {
        "data": {
          "type": "currencies",
          "id": "USD"
        }
      }
    },
    "meta": {
      "externalId": "cb8ff63f-cb92-4328-b3c7-b54e2b6dbc5f",
      "balanceTotal": "100.00",
      "createdAt": "2023-07-12T19:00:00.000Z",
      "updatedAt": "2023-07-12T19:00:00.000Z"
    }
  }
}

---

Delete account

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.

DELETEhttps://api.testbank.dev/accounts/{accountId}

Path parameters

accountId*string

Account ID

Example: "a1b2c3d4e5"

Header parameters

Response

204401403404412500

Confirmation the account is deleted.

Request

JavaScriptCurl

const response = await fetch('https://api.testbank.dev/accounts/{accountId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

• 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.

---

The root account

The root account for Testbank is special. You can credit your account from the root account to generate a balance to play with, or you can empty your account to the root account to clear your account out.