Cancel Mandate

To cancel an existing mandate, merchants can initiate a PATCH request to the endpoint below using the mandateCode and we will annul the existing mandate.

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/cancel-mandate/{{mandateCode}}

HTTP Method: PATCH

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

Sample Request

PATCH https://sandbox.monnify.com/api/v1/direct-debit/mandate/cancel-mandate/MTDD%7C01HW2SXG652BPQ0WJDGG91806Z

Sample response

{
   "requestSuccessful": true,
   "responseMessage": "success",
   "responseCode": "0",
   "responseBody": {
       "responseMessage": "Mandate has been requested to be cancelled.",
       "mandateReference": "unique_ref3_02s600972",
       "mandateCode": "MTDD|01HY8W3FBKHTFBZP9DQ9KNHR1G",
       "mandateStatus": "ACTIVE"
   }
}

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	O	Customers account number to create a mandate on
accountName	M	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