Get Accounts

Get accounts

GET /api/v1/merchant/external/direct-debit/account/get-accounts/<beneficiary-id>

Get all bank accounts linked to a BVN after consent has been given

Headers

Name
Value

Content-Type

application/json

api-key

your organisation api key

Response

{
    "status": true,
    "message": "Bank Accounts retrieved",
    "detail": "Bank Accounts retrieved",
    "data": [
        {
            "accountDesignationname": "BUSINESS",
            "account_balance": "1520.75",
            "accountdesignation": "1",
            "accountname": "TechSolutions",
            "accountnumber": "54321098765",
            "accountstatus": "2",
            "accounttier": "Gold",
            "accounttype": "3",
            "accounttypename": "CURRENT",
            "bankcode": "044",
            "bankname": "Access Bank",
            "beneficiary": "bcb23002-a90d-4abc-921d-bb82ab123a45",
            "branch": "0085",
            "created_at": "2024-10-22T09:45:12.452312Z",
            "id": "c4565c7f-e1d2-467f-a01e-82d7af97d8c1",
            "institution": "5",
            "is_active": true,
            "mandatecode": "MAND001",
            "mandatereference": "REF101",
            "merchant": "21ffa76d-569b-32a1-bc18-257941f48b52",
            "nipcode": "000002",
            "status": "active",
            "updated_at": "2024-10-22T09:45:12.452312Z"
        },
        {
            "accountDesignationname": "INDIVIDUAL",
            "account_balance": "305.90",
            "accountdesignation": "2",
            "accountname": "Jane Doe",
            "accountnumber": "13579246801",
            "accountstatus": "1",
            "accounttier": "Silver",
            "accounttype": "2",
            "accounttypename": "SAVINGS",
            "bankcode": "063",
            "bankname": "Access Bank",
            "beneficiary": "acd22011-f90c-4bbc-921d-bf71de34a23f",
            "branch": "0041",
            "created_at": "2024-11-01T15:27:03.654218Z",
            "id": "b1234d7b-d9e0-423a-94c1-36dfab54c3d2",
            "institution": "3",
            "is_active": false,
            "mandatecode": null,
            "mandatereference": null,
            "merchant": "47ffc82d-546a-63d1-ae19-111903f58d63",
            "nipcode": "000004",
            "status": "pending",
            "updated_at": "2024-11-01T15:27:03.654218Z"
        }
    ]
}

Last updated