Amend Payment Schedule Status

PATCH

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

Amend an existing payment schedule status.

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

bodyobjectStatus change to apply to a payment schedule.

200OK. The payment schedule status was changed.

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 PATCH \
     --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "status": "Paused",
     "statusReasonDescription": "Customer requested a pause in payments"
     }'