Fetch customer partner account details

Returns an object containing the customer partner account information including the lockbox account information.

Response

This is the expected response if the request is completed successfully.

{
    "status": "success",
    "message": "Customer partner details retrieved successfully",
    "data": {
        "id": "9BDJCLPfimy4Kijv",
        "name": "Mashle",
        "street": null,
        "city": null,
        "state": null,
        "country": "BmR31Of0hnPCkva2",
        "email": "[email protected]",
        "contact_number": "07063694146",
        "bvn": null,
        "business_registration": null,
        "user": "sSmqvc8BGY5W5dtH",
        "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.0c2yXUe",
        "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/9BDJCLPfimy4Kijv",
        "faq_document_url": null,
        "faq_document_name": null,
        "faq_document_last_updated": null,
        "virtual_account_provider_id": "puVaYGLgnKLOAIkq",
        "channel_partner_id": "N50IAMKeDDra70pC",
        "lockbox_account": {
            "id": "ZGLHb5mXattGgWWt",
            "customer_partner_id": "9B3JCLPfimy4Kijv",
            "account_name": "SAMPLE LOCKBOX ACCOUNT",
            "account_number": "1111718191",
            "bank_name": "Guaranty Trust Bank",
            "status": "created",
            "meta": null,
            "deleted_at": null,
            "created_at": "2023-04-13T17:40:55.000Z",
            "updated_at": "2023-04-13T17:44:01.000Z"
        }
    }
}

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 _^object

id _^string

This is the ID of the customer partner.

app_key _^string

This is the app key of the customer partner account to be used in authentication.

lockbox_account _^object

This is the object containing the lockbox account information

Response

The response object

The `response` object