Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Direct Debits

Create a Direct Debit Mandate

Creates a new direct debit mandate for a customer.

post/v1/direct-debits

Headers

accountIdstring required

The vendor account ID

Request body

customerAccountNumberstring required
bankCodestring required
customerNamestring required
customerAddressstring
customerAccountNamestring required
amountnumber double required
frequency'VARIABLE' | 'WEEKLY' | 'EVERY_TWO_WEEKS' | 'MONTHLY' | 'EVERY_TWO_MONTHS' | 'EVERY_THREE_MONTHS' | 'EVERY_FOUR_MONTHS' | 'EVERY_FIVE_MONTHS' | 'EVERY_SIX_MONTHS' | 'EVERY_SEVEN_MONTHS' | 'EVERY_EIGHT_MONTHS' | 'EVERY_NINE_MONTHS' | 'EVERY_TEN_MONTHS' | 'EVERY_ELEVEN_MONTHS' | 'EVERY_TWELVE_MONTHS' required
narrationstring
customerPhoneNumberstring
merchantReferencestring required

A NUMERIC string (0-9) used to track a transaction. It must be unique per transaction.

startDatestring date-time required
endDatestring date-time required
customerEmailstring required
startImmediatelyboolean

Example request

{
  "customerAccountNumber": "0174534423",
  "bankCode": "101",
  "customerName": "Kolapo Ojo",
  "customerAddress": "maryland Ikeja computer village",
  "customerAccountName": "Kolapo Ojo",
  "amount": 100,
  "frequency": "WEEKLY",
  "narration": "test e mandate response",
  "customerPhoneNumber": "0807882343",
  "merchantReference": "120030740017",
  "startDate": "2025-08-29T14:58",
  "endDate": "2025-08-30T10:40",
  "customerEmail": "kolapo@gmail.com",
  "startImmediately": true
}

Response

Mandate created successfully

responseMessagestring required
responseCodestring required

Example response

{
  "responseMessage": "Success",
  "responseCode": "00",
  "data": {
    "mandateId": "e50b7835-502c-4cfe-9893-47657633d7a2",
    "merchantReference": "12003074001",
    "phoneNumber": "08073345562",
    "description": "Welcome to NIBSS e-mandate authentication service, a seamless and convenient authentication experience. Kindly proceed with a token payment of N50.00..."
  }
}