v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Create Mandate

This API lets you initiate a mandate on a customers bank account. Note: customer has to approve the mandate before it is in effect. The action the user would have to complete to approve the mandate, is contained within the response once the API call is made, in the responseDescription field

post/v2/mandate-mgt/mandates/

Request body

amountinteger required

This is the total amount to be debited during the course of the mandate

descriptionstring required

A description of what the mandate is for

startDatestring date required

When the mandate goes in effect

endDatestring date required

The last day any debit would/can be initiated using the created mandate

currencystring required

Response

200

amountinteger

descriptionstring

responseDescriptionstring

startDatestring

endDatestring

statusstring

referencestring

createdAtstring

Example response

{
  "amount": 72500,
  "description": "Subscription",
  "responseDescription": "Welcome to NIBSS e-mandate authentication service, a seamless and convenient authentication experience. Kindly proceed with a token payment of N50:00 into account number \"0008787867\" with GTBank. This payment will trigger the  authentication of your mandate. Thank You",
  "startDate": "2024-04-05T00:00:00.000Z",
  "endDate": "2024-10-31T00:00:00.000Z",
  "status": "initiated",
  "reference": "mr_0788b7b-767da-7878-8886-dc0788cd",
  "createdAt": "2024-04-04T08:04:05.474Z"
}