Skip to main content
GET
/
bankaccounts
/
{id}
Get a bank account
curl --request GET \
  --url https://api.smokeball.com/bankaccounts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "accountType": 0,
  "accountName": "John Smith",
  "accountNumber": "10436489",
  "bankName": "Commonwealth Bank",
  "branchNumber": "062201",
  "branchName": "Sydney"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Response

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

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the bank account.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
accountType
enum<integer>

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

Available options:
0,
1,
2,
3
Example:

0

​
accountName
string | null

Account Name.

Example:

"John Smith"

​
accountNumber
string | null

Account Number.

Example:

"10436489"

​
bankName
string | null

Bank Name.

Example:

"Commonwealth Bank"

​
branchNumber
string | null

Branch Number.

Example:

"062201"

​
branchName
string | null

Branch Name.

Example:

"Sydney"

⌘I