Create a Mandate
Last updated Aug 8th, 2024
get api.withmono.com/v3/payments/mandatesThis resource allows you to create your own mandate authorisation experience.
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.
Mandate Tokenisation
When authorizing new mandates with OTP, the request body remains unchanged. However, an otp_destinations field is included in the response, allowing the user to choose their preferred authorization method.
The OTP verification process is managed in the Verify Mandate OTP API.
Re Debit Types & Amount
variable: When debit type is
variabletheamountis the total debit/money a business plans to collect from a customer over the set period. Debits can be variedfixed: When debit type is
fixedtheamountis that which the business wants to collect 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/v3/payments/mandates \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"debit_type": "variable",
"customer": "string",
"mandate_type": "string",
"amount": "integer",
"reference": "string",
"account_number": "string",
"bank_code": "string",
"description": "string",
"start_date": "string",
"end_date": "string"
}
'
Response
Choose an option from the drop down or click one of these buttons to see an example: