...
| Info |
|---|
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/merchant/direct-debit/mandate/?mandateReference={{mandateReferencemandatereference}}
HTTP Method: GET
| Info |
|---|
The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url. |
...
| Code Block |
|---|
|
GET https://sandbox.monnify.com/api/v1/merchant/direct-debit/mandate/dddjjdn12739 |
Sample Response
| Code Block |
|---|
| language | json?mandateReferences=shdjdii9292 |
|---|
Sample Responses
| Expand |
|---|
| title | Active Mandate Response |
|---|
|
| Code Block |
|---|
| {
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": [
{
"mandateCode": "MTDD|01J2KVEZXYQG9EB0P7F0QT1TH1",
"mandateReference": "unique_ref_LiveCard-17",
"startDate": "2024-07-12T09:15:30.000+00:00",
"endDate": "2025-04-22T09:15:30.000+00:00",
"mandateStatus": "ACTIVE",
"mandateAmount": 199.00,
"autoRenew": false,
"customerPhoneNumber": "+2348166189142",
"customerEmailAddress": "dogunnaike@moniepoint.com",
"customerAddress": "123 Example Street, City, Country 13",
"customerName": "Ahsan",
"customerAccountName": "Damilare Ogunnaike",
"customerAccountNumber": "0039300622",
"customerAccountBankCode": "221",
"mandateDescription": "Subscription Fee",
"debitAmount": 150,
"authorizationMessage": null,
"authorizationLink": null,
"responseMessage": "Active Mandate"
}
]
}
|
|
| Expand |
|---|
| title | Mandate With Pending Authorisation Response |
|---|
|
| Code Block |
|---|
| {
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": [
{
"mandateCode": "MTDD|01J3NARHGMMABYGW06KAB1D4A7",
"mandateReference": "test_ref_08072024-9",
"startDate": "2024-08-18T09:00:30.000+00:00",
"endDate": "2025-04-22T09:15:30.000+00:00",
"mandateStatus": "PENDING_AUTHORIZATION",
"mandateAmount": 120000.00,
"autoRenew": false,
"customerPhoneNumber": "08091385415",
"customerEmailAddress": "ankit.kushwaha@moniepoint.com",
"customerAddress": "12 David East Lagos",
"customerName": "Ojinaka Daniel Ifeanyi",
"customerAccountName": "OJINAKA DANIEL IFEANYI",
"customerAccountNumber": "0433003972",
"customerAccountBankCode": "058",
"mandateDescription": "Subscription Fee",
"debitAmount": null,
"authorizationMessage": "Request Ojinaka Daniel Ifeanyi to kindly proceed with a token payment of N50.00 into account number 9020025928 with Fidelity Bank. This transfer must be initiated from the account in the mandate request. This payment will trigger the authentication of customer and will authorize this mandate.",
"authorizationLink": "https://monnify-payment-pages.staging.monnify.com/mandate-auth/MTDD|01J3NARHGMMABYGW06KAB1D4A7?accountNumber=9020025928&bankName=Fidelity Bank&customerAccountName=OJINAKA+DANIEL+IFEANYI&amount=50.00",
"responseMessage": "Mandate is awaiting customer authorization - https://monnify-payment-pages.staging.monnify.com/mandate-auth/MTDD|01J3NARHGMMABYGW06KAB1D4A7?accountNumber=9020025928&bankName=Fidelity Bank&customerAccountName=OJINAKA+DANIEL+IFEANYI&amount=50.00"
}
]
}
|
|
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 |