Ctrlk
Log Support Ticket

💰Return All Accounts of a Bank Account

Return account details and transactional data from a Bank Account Record.

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

Path Parameters

Key
Type
Description

bank_account_id*

String

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

Optional Query Parameters

We also accept the following query parameters which will determine the fields which get returned in the response.

Key
Type
Description

full

Boolean

Send true for this parameter to get the posted_date for each transaction as well as the availableBalance in the account details. Banks sometimes have a transaction date "date" as well as a posted_date which is the date on which the transaction was recorded.

pending

Boolean

Send true for this parameter to return an additional is_pending boolean field which tells you whether a transaction has been fully processed by the bank (i.e. is_pending will be false) or is still in a pending state (i.e. is_pending will be true). You will also get a pendingAmount field returned in the account details which is the total amount for transactions where is_pending is true. Only applicable to certain banks that have this status available.

Status Codes

200 - OK

Single Account 

{
    "data": [
        {
            "id": "{{bankAccountId}}",
            "accountNumber": "XXX38037XXX",
            "accountName": "FNB PREMIER CURRENT ACCOUNT",
            "accountBalance": "41808.31",
            "accountHolder": "MISS JANE L SMITH",
            "accountAddress": "27 APPLE ST SANDTON EXT 2 2193",
            "transactions": [
                {
                    "id": "{{transactionId}}",
                    "type": "credit",
                    "amount": 120,
                    "description": "#Rev Monthly Account Fee",
                    "date": "2023-03-28T00:00:00",
                    "balance": 42385.74,
                    "category": "Income",
                    "category_slug": "income",
                    "category_type": null
                },
                {
                    "id": "{{transactionId}}",
                    "type": "debit",
                    "amount": 42,
                    "description": "POS Purchase Uber Rides 479012*3080 23 Mar",
                    "date": "2023-03-29T00:00:00",
                    "balance": 42343.74,
                    "category": "Expenses",
                    "category_slug": "expenses",
                    "category_type": null
                },
                {
                    "id": "{{transactionId}}",
                    "type": "debit",
                    "amount": 130,
                    "description": "POS Purchase Kleinkaap Boutique 479012*3080 25 Mar",
                    "date": "2023-03-29T00:00:00",
                    "balance": 42213.74,
                    "category": "Expenses",
                    "category_slug": "expenses",
                    "category_type": null
                },
                {
                    "id": "{{transactionId}}",
                    "type": "debit",
                    "amount": 405.43,
                    "description": "POS Purchase Woolworths 479012*3080 27 Mar",
                    "date": "2023-03-29T00:00:00",
                    "balance": 41808.31,
                    "category": "Expenses",
                    "category_slug": "expenses",
                    "category_type": null
                }
            ]
        }
    ]
}

Multiple Accounts 

{
  "data": [
    {
      "id": "{{bankAccountId1}}",
      "accountNumber": "XXX38037XXX",
      "accountName": "FNB PREMIER CURRENT ACCOUNT",
      "accountBalance": "41808.31",
      "accountHolder": "MISS JANE L SMITH",
      "accountAddress": "27 APPLE ST SANDTON EXT 2 2193",
      "transactions": [
        {
          "id": "{{transactionId}}",
          "type": "credit",
          "amount": 120,
          "description": "#Rev Monthly Account Fee",
          "date": "2023-03-28T00:00:00",
          "balance": 42385.74,
          "category": "Income",
          "category_slug": "income",
          "category_type": null
        },
        {
          "id": "{{transactionId}}",
          "type": "debit",
          "amount": 42,
          "description": "POS Purchase Uber Rides 479012*3080 23 Mar",
          "date": "2023-03-29T00:00:00",
          "balance": 42343.74,
          "category": "Expenses",
          "category_slug": "expenses",
          "category_type": null
        },
        {
          "id": "{{transactionId}}",
          "type": "debit",
          "amount": 405.43,
          "description": "POS Purchase Woolworths 479012*3080 27 Mar",
          "date": "2023-03-29T00:00:00",
          "balance": 41808.31,
          "category": "Expenses",
          "category_slug": "expenses",
          "category_type": null
        }
      ]
    },
    {
      "id": "{{bankAccountId2}}",
      "accountNumber": "XXX91245XXX",
      "accountName": "FNB SAVINGS ACCOUNT",
      "accountBalance": "15620.75",
      "accountHolder": "MISS JANE L SMITH",
      "accountAddress": "27 APPLE ST SANDTON EXT 2 2193",
      "transactions": [
        {
          "id": "{{transactionId}}",
          "type": "credit",
          "amount": 2500,
          "description": "Salary Transfer",
          "date": "2023-03-28T00:00:00",
          "balance": 18120.75,
          "category": "Income",
          "category_slug": "income",
          "category_type": null
        },
        {
          "id": "{{transactionId}}",
          "type": "debit",
          "amount": 1000,
          "description": "Transfer to Current Account",
          "date": "2023-03-29T00:00:00",
          "balance": 17120.75,
          "category": "Transfers",
          "category_slug": "transfers",
          "category_type": null
        },
        {
          "id": "{{transactionId}}",
          "type": "debit",
          "amount": 1500,
          "description": "Investment Debit Order",
          "date": "2023-03-30T00:00:00",
          "balance": 15620.75,
          "category": "Savings & Investments",
          "category_slug": "savings_investments",
          "category_type": null
        }
      ]
    }
  ]
}

No Transactions Available

{
    "data": [
        {
            "id": "ba4f8baa-7dcb-4582-8d00-993f4c624c5b",
            "accountNumber": "2XX4154XXX",
            "accountName": "Access Anytime Account",
            "accountBalance": 0,
            "overdraftLimit": 0,
            "accountHolder": "MR JOHN DYALE",
            "accountAddress": "7483 WEST STREET, MDANTSANE, EAST LONDON, 5219",
            "transactions": []
        }
    ]
}
400 - Bad Request

User Error 

{
    "data": "Online Banking Login Session User Error."
}

Inactive Banking Session 

{
    "data": "Online Banking Login Session has not been activated."
}

Incomplete Banking Session 

}
    "data": "Online Banking Session Incomplete."
}

Online Login Session Failed 

{
    "data": "Online Banking Session Failed."
}

Expired Online Login Session

{
    "data": "Online Banking Session Link has expired."
}
404 - Not Found

BankAccount ID not found

Last updated

Was this helpful?