Create Direct Debit Mandate
Get started with creating a direct debit mandate via API reference
Check Mandate Status
Check mandate status via API reference.
Create Direct Debit Mandate
To begin with the process of creating a Direct Debit mandate. The customer authorize the business, allowing them to debit their bank account for specified amounts and frequencies. The mandate includes details such as the customer’s bank account information, the amount to be debited, start date, end date and the frequency of the debits. In order to authorize the mandate, the customer will transfer an amount (N50) to the NIBSS provided account for validation.It’s important to note that the amount should be sent from the customer’s account number that is being used for the mandate
/v1/direct-debits
.
Frequency | Description |
---|---|
VARIABLE | The debit amount is not fixed. The business specifies the amount each time. |
WEEKLY | Debit occurs once every week. |
MONTHLY | Debit occurs once every month. |
QUARTERLY | Debit occurs once every three months. |
EVERY_TWO_MONTHS | Debit occurs once every two months. |
EVERY_THREE_MONTHS | Debit occurs once every three months. |
EVERY_FOUR_MONTHS | Debit occurs once every four months. |
EVERY_FIVE_MONTHS | Debit occurs once every five months. |
EVERY_SIX_MONTHS | Debit occurs once every six months. |
EVERY_SEVEN_MONTHS | Debit occurs once every seven months. |
EVERY_EIGHT_MONTHS | Debit occurs once every eight months. |
EVERY_NINE_MONTHS | Debit occurs once every nine months. |
EVERY_TEN_MONTHS | Debit occurs once every ten months. |
EVERY_ELEVEN_MONTHS | Debit occurs once every eleven months. |
EVERY_TWELVE_MONTHS | Debit occurs once every twelve months (yearly). |
Check Mandate Status
The status of the mandate is crucial for managing Direct Debit transactions. The possible statuses includeACTIVE
, SUSPENDED
, and DELETED
.
To check a mandate status, send a GET request to this endpoint /v1/direct-debits/status?mandateId={mandateId}
.
ADVICE_NOT_SENT
and ADVICE_SENT
. It’s essential to check the mandate advice status before initiating any debit transactions to ensure that the mandate is valid and active.
Debit Mandate
After the mandate is verified and activated, the business can initiate Direct Debit transactions according to the agreed schedule. The specified amounts will be automatically debited from the customer’s bank account and credited to the business’s account.Please not the following :
- Only mandates with an
ACTIVE
status can be used for debit transactions. - Only mandates with an ADVICE_SENT status can be used for debit transactions.
/v1/direct-debits/debit-mandate
.
GET MANDATE
To get a single mandate created, send a GET request to this endpoint/v1/direct-debits/<mandateId>
, you will pass the mandateID as path parameter.
List Direct debit
To list all direct debit created, send a GET request to this endpoint/v1/direct-debits/mandates
.
Update Direct debit Status
The status of the mandate can be updated as needed. For instance, if a customer wishes to cancel the mandate, the business can update the mandate status accordingly. To update a direct debit status, send a PUT request to this endpoint/v1/direct-debits/update-status
.