Get Payment Agreements by Date Range

GET

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

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

createdStartDatestringOptional. Start of the creation date range to search, in ISO 8601 date-time format. Cannot be a future date. It is recommended that either <code>createdStartDate</code> or <code>lastModifiedStartDate</code> is provided.

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> or more than 1 month after it. Defaults to <code>createdStartDate</code> + 24 hours.

lastModifiedStartDatestringOptional. Start of the last-modified date range to search, in ISO 8601 date-time format. It is recommended that either <code>createdStartDate</code> or <code>lastModifiedStartDate</code> is provided.

lastModifiedEndDatestringOptional. End of the last-modified date range to search, in ISO 8601 date-time format.

paymentAgreementUidstringOptional. Returns only the payment agreement with this <code>paymentAgreementUID</code>.

mmsIdstringOptional. Returns only the payment agreement with this MMS ID, the unique ID that identifies the payment agreement to the NPP.

subMerchantIdstringOptional. Returns only the payment agreements related to this sub-merchant ID.

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 agreements 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. No matching payment agreement could 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.

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/PaymentAgreement?createdStartDate=2026-10-01T00%3A00%3A00Z&createdEndDate=2026-10-15T23%3A59%3A59Z&lastModifiedStartDate=2026-10-01T00%3A00%3A00Z&lastModifiedEndDate=2026-10-15T23%3A59%3A59Z&paymentAgreementUid=MONPAG12345&mmsId=a9ba56f64baa1dee9ac2d7f87c2621fa&subMerchantId=93bf57eb1e2c42cf8101509b4356741e&pageNumber=1&pageSize=50' \
     --header 'accept: application/json'