Create Payment Schedule

POST

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

Create a schedule for automated payments.

acceptstringGenerated from available response content types

bodyobjectDetails of the payment schedule to create.

200OK. The payment schedule was created.

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 payment agreement 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 POST \
     --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "scheduleId": "MONSCH12345",
     "entityId": "MONPAG12345",
     "startDate": "2027-01-15",
     "endDate": "2027-12-15",
     "frequency": "MNTH",
     "scheduledAmount": 50,
     "totalInstances": 12,
     "totalAmount": 600,
     "paymentReference": "ABC Corp monthly subscription"
     }'