Bank accounts

This object provides information about a bank account, which can be a checking, savings, or a credit card account.

Get a bank account

get/objects/cash-management/bank-account/{key}

Returns detailed information for a specified bank account.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the bank account.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "29",
    • "referenceKey": "90",
    • "id": "CITI",
    • "name": "CitiBank12",
    • "currency": "USD",
    • "accountType": "checking",
    • "connectionStatus": "inProgress",
    • "supportMultiAccountLinking": true,
    • "financialInstitution": {
      • "id": "8",
      • "key": "8",
      • "href": "/objects/cash-management/financial-institution/8"
      },
    • "href": "/objects/cash-management/bank-account/29"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}