API Reference

Fetch all customer partner accounts

GET /v1/channel-partner/:channel_partner_id/customers

Returns an array of all customer partner accounts attached to your integration

Response

This is expected response if the request is completed successfully.

{
    "status": "success",
    "message": "Customer partners retrieved successfully",
    "data": [
        {
            "id": "9B3JCLPfimyRKijv",
            "name": "Mashle",
            "street": null,
            "city": null,
            "state": null,
            "country": "Bm231Of0hnPCkva2",
            "email": "[email protected]",
            "contact_number": "07063694176",
            "bvn": null,
            "business_registration": null,
            "user": "sSmqdc8BfY5W5dtH",
            "capital_partner_cash_account": null,
            "capital_partner_cash_account_number": null,
            "capital_partner_asset_account": null,
            "capital_partner_asset_account_number": null,
            "customer_partner_capital_loan_account": null,
            "customer_partner_capital_loan_account_number": null,
            "customer_partner_capital_loan_repayment_account": null,
            "customer_partner_capital_loan_repayment_account_number": null,
            "is_deleted": false,
            "created_at": "2023-04-14T16:19:12.000Z",
            "updated_at": "2024-06-05T01:00:07.000Z",
            "license_partner": null,
            "finance_cycles": 7,
            "tin": null,
            "legal_name": null,
            "business_email": null,
            "business_address": null,
            "support_email": null,
            "customer_partner_account_id": "tOcB7SmNaZLYV07I",
            "country_id": "BmR31Of0hnPCkva2",
            "meta": null,
            "contact_name": null,
            "app_key": "$2a$10$23JONQRDheuObQKCin2aiOlvY18MvW9d7U7ZiOwVbtgIC.0c2yXe",
            "transaction_score": "100.00",
            "drawdown_score": "100.00",
            "score": "0.00",
            "slug": "rank-ng",
            "transaction_performance_document_url": null,
            "transaction_performance_document_name": null,
            "transaction_performance_document_last_updated": null,
            "webhook_url": "https://43de-2c0f-2a80-9f-10-984-e315-4b85-1439.ngrok-free.app/v1/webhook/test",
            "data_sharing_webhook_url": "https://staging.api.b54.co/webhooks/9B3JCLPfimy4Kijv",
            "faq_document_url": null,
            "faq_document_name": null,
            "faq_document_last_updated": null,
            "virtual_account_provider_id": "puVaYGLgnKLOAIkq",
            "channel_partner_id": "N50IAMKeDDra70pC"
        }
    ]
}

The response object

status string
This is the status of the request. It can be either success or error

message string
This is a message describing the outcome of the request sent to the server.

data array of object