...
| 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/debit-status?paymentReference={{paymentReference}}
...
| Code Block |
|---|
GET https://sandbox.monnify.com//api/v1/merchant/direct-debit/mandate/debit-status?paymentReference=PR1234567940015PR1234567991402 |
Sample Response
| Code Block |
|---|
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"transactionStatus": "PAID",
"transactionReference": "MNFY|20240724092716|000001",
"paymentReference": "PR1234567991400000006",
"debitAmount": 50.00,
"narration": "Payment for Services",
"mandateCode": "MTDD|01J3G4ABDV8RJ12GN0X9HP1B10"
} |
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 |
O | 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 |