Direct Debit Integration Guide: Customers
Last updated May 13th, 2024
Step 1: Create a Customer
Before a Direct Debit mandate can be set up on an account, it is important to create a customer profile. Creating a customer requires the user's first name, last name, phone number, bvn, house address and email.
Re: Mandates on Business Accounts
Kindly note that when creating a customer/mandate for a business account, you need to pass in the business name split as firstName & lastName. Also, the KYC identity type - BVN must belong to one of the share holders of the company.
To create a customer, send a POST request to the following endpoint:
Request
POST https://api.withmono.com/v2/customers
Creating an Individual Customer
Request Body Parameters
| Field | Description |
| email (required) | The email of the customer. |
| firstName (required) | The first name of the customer. |
| lastName (required) | The last name of the customer. |
| address (required) | The house address of this customer |
| phone (required) | The phone number of this customer. |
| identity.type (required) | The KYC identity type of the user should be "bvn". |
| identity.number (required) | The BVN identity number associated with the customer. |
cURL Sample Request
Request
curl --request POST \
--url https://api.withmono.com/v2/customers \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'mono-sec-key: live_sk_qwertyuiop' \
--data '
{
"identity": {
"type": "bvn",
"number": "09876543212"
},
"email": "samuelolamide@gmail.com",
"firstName": "Samuel",
"lastName": "Olamide",
"address": "Agungi, Lagos",
"phone": "08012345678"
}
'
Success Response
If the initiation request is successful, you will receive the following response:
Request
{
"status": "successful",
"message": "Created customer successfully",
"data": {
"id": "6578295bbf09b0a505123456",
"name": "Samuel Olamide",
"first_name": "Samuel",
"last_name": "Olamide",
"email": "samuelolamide@gmail.com",
"phone": "08012345678",
"address": "Agungi, Lagos",
"identification_no": "0123456789",
"identification_type": "bvn",
"bvn": "0123456789"
}
}
Other API actions that can be taken when managing your customer include: