⬆️Update BankAccount Type

A Customers Bank Account Type may be updated if required.

Update BankAccount Type

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

Path Parameters

Key	Value	Description
bank_account_id*	String	The UUID for a customers Bank Account that gets generated and returned in the POST Create New Bank Account response. The Bank Account types include online, statement and USSD.

Status Codes

200 - OK

Bank Account Type Updated

{
    "data": {
        "id": "{{bankAccountId}}",
        "customer_id": "{{customerId}}",
        "type": "statement",
        "bank": "absa",
        "num_transactions": 0,
        "last_updated": "2023-04-20T13:48:35.000000Z",
        "first_transaction": null,
        "last_transaction": null
    }
}

404 - Not Found

Bank Account Not Found

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

422 - Unprocessable Content

Bank Type can not be updated

{
    "errors": {
        "bank": [
            "Bank can not be updated."
        ]
    }
}

Example

Before: Available Bank Account Record

{
    "data": {
        "id": "{{bankAccountId}}",
        "customer_id": "{{customerId}}",
        "type": "online",
        "bank": "absa",
        "num_transactions": 0,
        "last_updated": "2023-04-20T13:47:35.000000Z",
        "first_transaction": null,
        "last_transaction": null
    }
}

Patch: Updating the bank account type

{
    "bank":"absa",
    "type": "statement"
}

After: Updated Bank Account Type

{
    "data": {
        "id": "{{bankAccountId}}",
        "customer_id": "{{customerId}}",
        "type": "statement",
        "bank": "absa",
        "num_transactions": 0,
        "last_updated": "2023-04-20T13:48:35.000000Z",
        "first_transaction": null,
        "last_transaction": null
    }
}