โš–๏ธReturn all Transactions from a Bank Account

Return a list of object literals which represent Customer Transactional data that has been read from either the Customers Internet Banking profile or Customers Bank Statement/s uploaded.

Return all Transaction from a BankAccount

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

Path Parameters

NameTypeDescription

bank_account_id*

String

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

Query Parameters

NameTypeDescription

account_id

String

[Online only] The UUID for an Account within a Bank Account that gets generated and returned after the Online Login process has been successfully completed.

When the person logs, each account within the Internet Banking

Status Codes

200 - OK

Transaction Success

{
    "data": [
        {
            "id": "{{transactionId}}",
            "type": "debit",
            "amount": 140,
            "description": "Pos Purchase Card No. 3306 The Archive Automotive Garde (Effective 08/02/2023)",
            "date": "2023-02-11T00:00:00",
            "balance": 21466.56,
            "category": "Expenses",
            "category_slug": "expenses",
            "category_type": null
        },
        {
            "id": "{{transactionId}}",
            "type": "debit",
            "amount": 50,
            "description": "Pos Purchase Card No. 3306 Salt (Effective 10/02/2023)",
            "date": "2023-02-11T00:00:00",
            "balance": 21416.56,
            "category": "Expenses",
            "category_slug": "expenses",
            "category_type": null
        },
        {
            "id": "{{transactionId}}",
            "type": "debit",
            "amount": 88,
            "description": "Pos Purchase Card No. 3306 Grate Cafe (Effective 17/02/2023)",
            "date": "2023-02-21T00:00:00",
            "balance": 21328.56,
            "category": "Expenses",
            "category_slug": "expenses",
            "category_type": null
        },
        {
            "id": "{{transactionId}}",
            "type": "debit",
            "amount": 500,
            "description": "Prepaid Debit Card No. 6570 Electricity: 14298476087",
            "date": "2023-02-28T00:00:00",
            "balance": 20828.56,
            "category": "Expenses",
            "category_slug": "expenses",
            "category_type": null
        },
        {
            "id": "{{transactionId}}",
            "type": "debit",
            "amount": 115,
            "description": "Monthly Acc Fee",
            "date": "2023-03-01T00:00:00",
            "balance": 20713.56,
            "category": "Fee",
            "category_slug": "fee",
            "category_type": null
        }
    ]
}
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."
}

Last updated