List all mandates
You can see a list of your mandates. The mandates are returned sorted by creation date, with the most recent appearing first. You can use this API method and the limit parameter to page through mandates. You can also filter for status and variant. You can use any combination of these arguments.
ARGUMENTS
Scroll inside to view more
|
Argument
|
Description
|
|---|---|
limit optional, default is 100
| A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 100.
|
status optional
| A filter on the status of the mandates to be returned e.g. status=active.
|
variant optional
| A filter on the variant of the mandates to be returned e.g. variant=physical.
|
page optional
| This will return all the mandates in the respective page.
|
Returns A dictionary with a data property that contains an array of up to limit mandates and when you pass page it will return you all the entries in the respective page.Each entry in the array is a separate mandate object. If no more mandates are available, the resulting array will be empty. If you provide a non-existent filter, this call returns an error. Note: Limited API Keys will return only those objects to which they are associated.
Request
Response
API Endpoints
Sandbox Link
GET
https://api-test.lotuspay.com/v1/mandates
Production Link
GET
https://api.lotuspay.com/v1/mandates