Versions Compared

Key

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

...

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

...

Code Block
languagejson
{
  "paymentReference": "PR1234567940019PR1234567991402",
  "mandateCode": "50MTDD|01HW2Q36KZGMXSWN7E76893V42",
  "debitAmount": 100010000.00,
  "narration": "Payment for Services",
  "customerEmail":"ankit@gmailbenjamin.on@gmail.com"
}

Sample Response

Code Block
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionStatus": "PENDING",
        "responseMessage": "Debit mandate request accepted for processing",
        "transactionReference": "MNFY|20240422140658|000002",
        "paymentReference": "PR1234567991402",
        "debitAmount": 10000.00,
        "narration": "Payment for Services",
        "mandateCode": "MTDD|01HW2Q36KZGMXSWN7E76893V42"
    }
}

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