Sign in

v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Fetch Mandate Information/status

This API lets you get the details of a mandate using the mandate reference

get/v2/mandate-mgt/mandates/reference/{mandate_reference}

Path parameters

mandate_referencestring required

The reference for the mandate which was returned in the payload response when mandate was created

Response

200

amountinteger
descriptionstring
responseDescriptionstring
startDatestring
endDatestring
statusstring
referencestring
createdAtstring

Example response

{
  "amount": 72500,
  "description": "Recurring loan repayment",
  "startDate": "2024-04-04T00:00:00.000Z",
  "endDate": "2024-10-31T00:00:00.000Z",
  "status": "approved",
  "reference": "mr_9dcere51-49f0-8347-9051-438783748",
  "createdAt": "2024-04-03T09:56:34.812Z"
}