v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Bank Accounts

Show Bank Account

Show details of a specific Bank Account using a given :id.

get/bank_accounts/{id}

Path parameters

idstring required
Example:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Bank account ID

Query parameters

include_decrypted_fieldsboolean
Example:true

If true, the API will decrypt and return sensitive bank account fields (for example, the full account number). Defaults to false

Response

OK

Example response

{
  "bank_accounts": {
    "active": true,
    "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
    "currency": "AUD",
    "verification_status": "not_verified",
    "bank": {
      "bank_name": "Bank of Australia",
      "country": "AUS",
      "account_name": "Samuel Seller",
      "routing_number": "XXXXX3",
      "account_number": "XXX234",
      "holder_type": "personal",
      "account_type": "checking",
      "direct_debit_authority_status": "approved"
    }
  }
}