Get bank accounts

Returns a list of bank accounts.

GET /bankaccounts

Get bank accounts

cURL

curl --request GET \
  --url https://api.smokeball.com/bankaccounts \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "type": "Trust",
      "status": 0,
      "matter": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "accountName": "John Smith",
      "accountNumber": "10436489",
      "bankName": "Commonwealth Bank",
      "branchNumber": "062201",
      "branchName": "Sydney",
      "balance": 1000,
      "contactBalances": [
        {
          "matter": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          },
          "contact": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          },
          "balance": 1000,
          "protectedBalance": 1000,
          "availableBalance": 1000
        }
      ],
      "matterBalances": [
        {
          "matter": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          },
          "balance": 1000,
          "protectedBalance": 1000,
          "availableBalance": 1000,
          "unpresentedChequesBalance": 0
        }
      ]
    }
  ]
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

type · string

matterId · string

Response

200

application/json

When request is successful. Returns a collection of 'BankAccount' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes