Get Payment Agreements
Retrieve a paginated list of payment agreements within a specified time range. This endpoint enables merchants to query and filter payment agreements based on date parameters, allowing for efficient management and monitoring of agreement records over a specified period.
The query supports pagination, making it possible to navigate through large datasets by specifying the page number and the number of records per page.
Authorizations
A unique identifier assigned to each application.
A secure token associated with the app-id.
Query Parameters
The start date for querying payment agreements. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.
The end date for querying payment agreements. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.
The page number to retrieve. Each page contains a subset of results based on the specified size parameter.
The number of records to return per page. This allows you to control the volume of data returned in each response, aiding in efficient data management.
Response
Request processed successfully.
The start date of the queried payment agreements, as specified in the request.
"2022-01-01T00:00:00"
The end date of the queried payment agreements, as specified in the request.
"2022-12-01T00:00:00"
The current page number of the returned results.
1
The number of records per page as specified in the query.
20
The page number for the next set of results, if available.
2
The total number of pages available based on the query parameters.
5
The total number of payment agreement records available within the specified date range.
100