...
Endpoint URL: {{base_url}}/api/v1/merchant/direct-debit/mandate/?mandateReference={{mandateReferencemandatereference}}
HTTP Method: GET
| Info |
|---|
The {{base_url}} for test is |
...
| Code Block | ||
|---|---|---|
| ||
GET https://sandbox.monnify.com/api/v1/merchant/direct-debit/mandate/dddjjdn12739?mandateReferences=shdjdii9292 |
Sample Response
| Code Block | ||
|---|---|---|
| ||
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": [
{
"mandateCode": "MTDD|01HW2S3BN6XEPYD90PP3VEZXG3",
"externalMandateReference": "shdjdii9292",
"startDate": "2024-05-19T09:15:30.000+0000",
"endDate": "2025-01-19T09:15:30.000+0000",
"mandateStatus": "ACTIVE",
"mandateAmount": 100000.00,
"contractCode": "4934121686",
"autoRenew": true,
"customerPhoneNumber": "1234567890",
"customerEmailAddress": "benjamin.on@gmail.com",
"customerAddress": "123 Example Street, City, Country",
"customerName": "Marvelous Benji",
"customerAccountName": "Benjamin Wilson",
"customerAccountNumber": "8088523230",
"customerAccountBankCode": "305",
"mandateDescription": "Subscription Fee",
"debitAmount": null,
"authorizationMessage": null,
"authorizationLink": null
}
]
} |
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 |