Initiate Mandate Authorisation
Last updated Aug 8th, 2024
post api.withmono.com/v2/payments/initiateThis resource returns a link for your customers to authorise their mandate.
Regarding the readiness for debiting the account:
Signed Mandate: Upon bank approval, signed mandate accounts are immediately available for debiting and balance inquiries.
E-mandate: With an e-mandate setup, a waiting period of 1 hour max should be observed following approval before debiting and balance inquiries can be conducted.
Re Debit Types & Amount
variable: When debit type is
variabletheamountis the total debit/money a business plans to retrieve from a customer over the set period. Debits can be variedfixed: When debit type is
fixedtheamountis that which the business wants to retrieve per debit and then the total debit is automatically calculated based on that amount. Note that once the fixed amount is set on mandate authorisation, it is immutable.
Request
curl --request POST \
--url https://api.withmono.com/v2/payments/initiate \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'mono-sec-key: string' \
--data {
"amount": 9190030,
"type": "recurring-debit",
"method": "mandate",
"mandate_type": "emandate", // or "signed" or "gsm"
"debit_type": "variable", // or "fixed"
"description": "Repayment for samuel.olamide@mono.co",
"reference": "test-O2b9O9EF903-949493432",
"redirect_url": "https://mono.co",
"customer": {
"id":"65eb623b0000900009e5c1f21cd"
},
"start_date": "2024-03-29",
"end_date": "2024-08-04",
"meta": {}
}
Response
Choose an option from the drop down or click one of these buttons to see an example: