API Reference

Lockbox withdrawal

POST /v1/baas/customer-partner/{{customer_partner_id}}/withdraw

This endpoint is used to transfer funds from the lockbox account into your bank account and mobile money account.


Payload (Bank)

This is the payload expected for the transfer of funds from the lockbox account to any other bank account. If you have not gone through our guide on a quick set up to making api requests, check here

{
    "name": "Adedotun Adepoju",
    "amount": 2000,
    "account_type": "bank",
    "account_number": "0885991218",
    "bank_code": "057"
}

The payload object

Compulsory Fields

name string
This is name of the account.

amount string
This is the amount you want to transfer.

account_type string
This specifies that the transfer is bank transfer instead of mobile money.

account_number string
This is a string of numbers that serve as unique identifier for your account.

bank_code string
This is a unique code assigned to your bank.

Payload (Mobile Money)

This is the payload expected for the transfer of funds from the lockbox account to any mobile money account. If you have not gone through our guide on a quick set up to making api requests, check here

{
    "amount": 2000,
    "account_type": "mobile-money",
    "mobile_no": "229XXXXXX01X",
    "correspondent": "MTN_MOMO_BEN",
    "narration": "Test"
}

The payload object

Compulsory Fields

amount string
This is the amount you want to transfer.

account_type string
This specifies that the transfer is a mobile-money transfer instead of a bank transfer.

mobile_no string
This is the phone number used on the account.

correspondent string
This is the name of the mobile money correspondent.

narration string
This is a text for describing your transaction.

Response

This is the expected response if the request is successful. Listen to your webhook, for the transfer's final status. See our webhooks

{
    "status": "success",
    "message": "Transfer in progress. Please check your email for notification(s) in some minutes",
    "data": []
}