Get Payment Schedules by Date Range

GET

https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule

Retrieve a list of payment schedules created in a date range.

statusstringOptional. Returns only schedules with this status. Accepted values: <code>Pending</code>, <code>Active</code>, <code>Paused</code>, <code>Cancelled</code>.

createdStartDatestringOptional. Start of the creation date range to search, in ISO 8601 date-time format. Cannot be a future date.

createdEndDatestringOptional. End of the creation date range to search, in ISO 8601 date-time format. Cannot be a future date. Cannot be earlier than <code>createdStartDate</code>.

pageNumberinteger<int32>Optional. Page to return after the records are split by <code>pageSize</code>. Must be 1 or greater. If not provided, defaults to 1.

pageSizeinteger<int32>Optional. Number of records per page, from 1 to 500.

acceptstringGenerated from available response content types

200OK. Returns the payment schedules that match the search criteria.

400Bad Request. The request failed validation. See <code>errors</code> for details.

401Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.

403Forbidden. Your account is not permitted to perform this operation.

404Not Found. The account could not be found.

500Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.

502Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.

503Service Unavailable. The service is temporarily unavailable. Retry the request later.

504Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.

curl --request GET \
     --url 'https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule?status=Active&createdStartDate=2026-10-01T00%3A00%3A00Z&createdEndDate=2026-10-15T23%3A59%3A59Z&pageNumber=1&pageSize=50' \
     --header 'accept: application/json'