SMsmokeball
Bank Accounts

Get a bank account

Retrieves a specified bank account.

get/bankaccounts/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/bankaccounts/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Response

When request is successful. Returns a 'BankAccount' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the bank account.

typestring

The type of the bank account (Operating, Trust, Credit, ControlledMoney).

status0 | 1
accountTypeinteger

The type of the bank account (Operating = 0, Trust = 1, Credit = 2, ControlledMoney = 3).

This field is deprecated and scheduled for removal - use the Type field instead.

accountNamestring nullable

Account Name.

accountNumberstring nullable

Account Number.

bankNamestring nullable

Bank Name.

branchNumberstring nullable

Branch Number.

branchNamestring nullable

Branch Name.

balancenumber double

Total balance of the bank account.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "type": "Trust",
  "accountName": "John Smith",
  "accountNumber": "10436489",
  "bankName": "Commonwealth Bank",
  "branchNumber": "062201",
  "branchName": "Sydney",
  "balance": 1000,
  "contactBalances": [
    {
      "balance": 1000,
      "protectedBalance": 1000,
      "availableBalance": 1000
    }
  ],
  "matterBalances": [
    {
      "balance": 1000,
      "protectedBalance": 1000,
      "availableBalance": 1000
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.