๐Ÿ”ŽFind a Single BankAccount

Lookup and retrieve a single Consumer Bank Account by bank_account_id.

Get Single BankAccount

GET {{baseUrl}}/bank-accounts/:bank_account_id

Path Parameters

KeyValueDescription

bank_account_id*

String

The UUID for a customers Bank Account that gets generated and returned in the POST Create New Bank Account response.

Status Codes

200 - OK

Bank Account Found

{
    "data": {
        "id": "{{bankAccountId}}",
        "customer_id": "{{customerId}}",
        "type": "statement",
        "bank": "absa",
        "num_transactions": 0,
        "last_updated": "2023-05-02T08:00:16.000000Z",
        "first_transaction": null,
        "last_transaction": null
    }
}
401 - Unauthorised

Unauthenticated

{
    "error": "Unauthenticated."
}

404 - Not Found

Bank Account Not Found

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in module_bank_accounts"
    }
}

Last updated