Get mandates
Retrieve a paged list of DebiPay mandates using the collection endpoint.
Query Parameters
^-?(?:0|[1-9]\d*)$^-?(?:0|[1-9]\d*)$^-?(?:0|[1-9]\d*)$Use this endpoint to list mandates that match your query criteria. It is suitable for merchant dashboards, customer support tools, and reconciliation tasks where you need to review multiple mandate records at once.
The collection endpoint supports pagination and filtering by mandate type or merchant, which makes it suitable for large mandate inventories.
Query parameters
You can use the following query filters with the request:
Keyfor simple text search supportPageandPageSizefor paginationMandateTypeIdto filter by mandate typeMerchantIdto narrow the results to a specific merchant
Response handling
The response returns a paged result set of mandate records. Review the generated schema in the right panel to understand the fields included in each item and the pagination metadata returned with the payload.
Use pagination when you expect a large number of mandates so the API can return a manageable page size.