Amend Payment Schedule

PUT

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

Amend an existing payment schedule.

scheduleIdstringID that uniquely identifies the payment schedule. This is the <code>scheduleId</code> supplied when the schedule was created.

acceptstringGenerated from available response content types

bodyobjectChanges to a payment schedule. Include only the fields you want to change.

200OK. The payment schedule was amended.

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