📁Return All Statements of a BankAccount

Return all the PDF bank statements stored on a Bank Account Record.

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

Path Variables

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.

API Responses

200 - OK

Online Login

{
    "data": [
        {
            "id": "{{statementId}}",
            "bank_account_id": "{{bankAccountId}}",
            "statement_date": "2023-01-09",
            "start_date": "2022-12-09",
            "end_date": "2023-01-09",
            "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/testing/client_8de80ed8-8495-428d-a6a8-acd30a9ab01a/statements/9001145117080/c5a6beab-727c-4019-a654-cd5ceaf2f543/bank_account/62796664946-0.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230118%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230118T170012Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=868205de3c818e119b73b10e8ea4248e95e15cdafe8096bd71ef21465809d4c3",
            "expires_in": "60m",
            "file": {
                "id": 2718,
                "name": "62796664946-0.pdf",
                "type": "pdf",
                "url": "https://dev.apply.fincheck.co.za/fincheck/documents/62796664946-0.pdf"
            },
            "transaction_count": 101,
            "month": "Dec 2022",
            "fraud": null
        },
        {
            "id": "{{statementId}}",
            "bank_account_id": "{{bankAccountId}}",
            "statement_date": "2022-12-09",
            "start_date": "2022-11-09",
            "end_date": "2022-12-09",
            "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/testing/client_8de80ed8-8495-428d-a6a8-acd30a9ab01a/statements/9001145117080/c5a6beab-727c-4019-a654-cd5ceaf2f543/bank_account/62796664946-1.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230118%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230118T170012Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=b159e011c385bb21f7a2557e5b516a5e18413e5cea8bec220aad3955a1149d69",
            "expires_in": "60m",
            "file": {
                "id": 2719,
                "name": "62796664946-1.pdf",
                "type": "pdf",
                "url": "https://dev.apply.fincheck.co.za/fincheck/documents/62796664946-1.pdf"
            },
            "transaction_count": 157,
            "month": "Nov 2022",
            "fraud": null
        },
        {
            "id": "{{statementId}}",
            "bank_account_id": "{{bankAccountId}}",
            "statement_date": "2022-11-09",
            "start_date": "2022-10-08",
            "end_date": "2022-11-09",
            "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/testing/client_8de80ed8-8495-428d-a6a8-acd30a9ab01a/statements/9001145117080/c5a6beab-727c-4019-a654-cd5ceaf2f543/bank_account/62796664946-2.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230118%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230118T170012Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=3ee2302e94a9135c785e0764e6aa72f4e081bb4a0287b316f27819e2be12e766",
            "expires_in": "60m",
            "file": {
                "id": 2720,
                "name": "62796664946-2.pdf",
                "type": "pdf",
                "url": "https://dev.apply.fincheck.co.za/fincheck/documents/62796664946-2.pdf"
            },
            "transaction_count": 92,
            "month": "Oct 2022",
            "fraud": null
        }
    ]
}

Statement Upload

{
    "data": [
        {
            "id": "{{statementId}}",
            "bank_account_id": "{{bankAccountId}}",
            "statement_date": "2023-03-28",
            "start_date": "2023-02-28",
            "end_date": "2023-03-28",
            "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/uat/client_67ec56bb-0901-4dd6-91a3-4d9d4231cd9e/bank_accounts/9208010020089/a0938ebc-decc-4060-873b-953d0ec7630c/bank_account/1.8-FNB_PREMIER_CURRENT_ACCOUNT_13.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230502%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230502T105323Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=54b29dea69b10a6706a75142ea1cb5330517adafaf39c097d2ee043de2f646e9",
            "expires_in": "60m",
            "file": {
                "id": 1041,
                "name": "1.8 FNB_PREMIER_CURRENT_ACCOUNT_13.pdf",
                "type": "pdf",
                "url": "http://uat.apply.fincheck.co.za/gathr/documents/1.8%20FNB_PREMIER_CURRENT_ACCOUNT_13.pdf"
            },
            "transaction_count": 75,
            "month": "Feb 2023",
            "fraud": {
                "fraud_checks": {
                    "statement_balance": false,
                    "create_date": false,
                    "meta_mod_date": false,
                    "meta_producer": false,
                    "meta_creator": false,
                    "meta_author": false
                }
            },
            "processed": true
        },
        {
            "id": "{{statementId}}",
            "bank_account_id": "{{bankAccountId}}",
            "statement_date": "2023-02-28",
            "start_date": "2023-01-28",
            "end_date": "2023-02-28",
            "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/uat/client_67ec56bb-0901-4dd6-91a3-4d9d4231cd9e/bank_accounts/9208010020089/a0938ebc-decc-4060-873b-953d0ec7630c/bank_account/1.7-FNB_PREMIER_CURRENT_ACCOUNT_12.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230502%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230502T105323Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=da93bb5c4bb99f771b5d52bbde2a7e7984ead8d06bff2c5a8e361dcce683b31e",
            "expires_in": "60m",
            "file": {
                "id": 1042,
                "name": "1.7 FNB_PREMIER_CURRENT_ACCOUNT_12.pdf",
                "type": "pdf",
                "url": "http://uat.apply.fincheck.co.za/gathr/documents/1.7%20FNB_PREMIER_CURRENT_ACCOUNT_12.pdf"
            },
            "transaction_count": 105,
            "month": "Jan 2023",
            "fraud": {
                "fraud_checks": {
                    "statement_balance": false,
                    "create_date": false,
                    "meta_mod_date": false,
                    "meta_producer": false,
                    "meta_creator": false,
                    "meta_author": false
                }
            },
            "processed": true
        }
    ]
}

400 - Bad Request

Inactive Online Login Session

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

Incomplete Online Login Session

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

Failed Online Session

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

Expired Online Session

{
    "data": "Online Banking Login Session has expired."
}

404 - Not Found

Invalid Paramter

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

Expected Online Login PDF Statements to be returned per bank

When completing a successful Online Login 3 months worth of PDF bank statements will be returned, either in a single 3-month statement or 3 separate 1-month statement.

Bank	PDF Statement
ABSA	1 x ABSA Transaction History PDF bank statment containing 3 months of transactional data
Capitec	1 x Capitec PDF bank statment containing 3 months of transactional data
Discovery	3 x Discovery PDF bank statment containing 1 month of transactional data
FNB	3 x FNB PDF bank statment containing 1 month of transactional data
Nedbank	3 x Nedbank PDF bank statment containing 1 month of transactional data
RMB	3 x RMB PDF bank statment containing 1 month of transactional data
Standard Bank	1 x Standard Bank PDF bank statment containing 3 months of transactional data
Tyme Bank	3 x Tyme Bank PDF bank statment containing 1 month of transactional data

Expected Manual Upload PDF Statements to be returned

The number of statements returned depends on how many statements were uploaded to a given bank_account_id using the POST Upload Bankstatement v1.0 or POST Upload Bankstatement v1.1.