Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sample Response

Code Block

On successful mandate creation, an authorisation link will be sent to the customer’s email address to enable the customer authorise the direct debit on his account. Once successfully authorised, merchant can periodically pass debits to the customer’s bank account till the mandateEndDate is reached.

Field Parameters

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

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

...