Debit Mandate

This API allows merchants to periodically pass debit to their customers' account. This can be done by simply initiating a POST request to the API as outlined below:

This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here

Endpoint URL: {{base_url}}/api/v1/direct-debit/mandate/debit

HTTP Method: POST

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url.

Sample Request

{
 "paymentReference": "PR0407202400000000000000000016",
 "mandateCode": "MTDD|01J28N9ED8RB1EK****R3NTPFN8",
 "debitAmount": 50.00,
 "narration": "Payment for Services",
 "customerEmail":"ankit@gmail.com"
}

Sample Response

{
   "requestSuccessful": true,
   "responseMessage": "success",
   "responseCode": "0",
   "responseBody": {
       "transactionStatus": "PENDING",
       "responseMessage": "Debit mandate request accepted for processing",
       "transactionReference": "MNFY|20240519180055|000001",
       "paymentReference": "PR1234567991002",
       "debitAmount": 1000,
       "narration": "Payment for Services",
       "mandateCode": "MTDD|01HY8WMN8JYKDRJC67QPQVS1N0"
   }
}

Field Parameters

Fields	Mandatory or Optional	Description

Fields	Mandatory or Optional	Description
contractCode	M	The merchant’s Monnify contract code
mandateReference	M	Merchants generated reference to identify a mandate
customerName	M	Name of merchants customer
customerPhoneNumber	M	Phone number of merchants customer
customerEmailAddress	M	Email address of merchants customer
customerAddress	M	Location of merchants customer
accountNumber	M	Customers account number to create a mandate on
accountName	O	Customers account name for the account to create a mandate on
bankCode	M	The bank code of the account number to create a mandate on
mandateAmount	M	Total lifetime amount debitable on the mandate.
mandateDescription	M	The description of the payment the mandate is associated to
mandateStartDate	O	StartDate of Mandate: default to mandate creation date
mandateEndDate	O	EndDate of Mandate: default to mandate creation date
mandateCode	O	Monnify generated mandate identifier
mandateStatus	O	The status of the mandate in request: INITIATED, ACTIVE, CANCELED
mandateAuthorizationLink	O	3Ds link presented to customers for authorization flow
paymentReference	M	Merchants unique reference to identify a single direct debit payment
debitAmount	O	Payment amount to be debited from a single debit transaction
narration	M	Description of the single debit