v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Direct Debits

Get Mandate Status

Fetches the status of a specific mandate by mandateId.

get/v1/direct-debits/status?mandateId={mandateId}

Query parameters

mandateIdstring required

Unique identifier of the mandate

Headers

accountIdstring required

The vendor account ID

Response

Mandate status fetched successfully

codestring required

descriptionstring required

messagestring required

statusboolean required

Example response

{
  "code": "00",
  "description": "SUCCESS",
  "data": {
    "customerAccountName": "Kolapo Ojo",
    "mandateId": "c93e1e1b-85f5-461e-8b9b-74ee091d4aa4",
    "customerAccountNumber": "0134914434",
    "mandateStatus": "Active",
    "rejectionComment": "Expired e-mandate",
    "mandateAdviceStatus": "Advise not sent"
  },
  "message": "SUCCESS",
  "status": true
}