v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

List all Mandates

This API lets you get all mandates that has been initiated by your merchant account. Note, the path param is passed in the url as a query parameter

get/v2/mandate-mgt/mandates/?perPage={perPage}

Path parameters

perPagestring required

Response

200

totalinteger
perPagestring
pageinteger

Example response

{
  "results": [
    {
      "amount": 72500,
      "description": "then",
      "startDate": "2024-04-05T00:00:00.000Z",
      "endDate": "2024-10-31T00:00:00.000Z",
      "status": "approved",
      "reference": "mr_3704d0-ee9e-382-4289-c3282381e2",
      "createdAt": "2024-04-04T13:07:36.702Z"
    }
  ],
  "total": 10,
  "perPage": "2",
  "page": 1
}