Bilateral Amendment Async

PATCH

https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/bilateral

The purpose of this endpoint is to asynchronously amend a payment agreement which requires approval from the Payer. Changes made using this end point will only get reflected after payer approves the change. The API returns as soon as the amend request has been captured and validated for background processing.

paymentAgreementUIDstringID that uniquely identifies the payment agreement. This is the <code>paymentAgreementUID</code> supplied when the agreement was created.

acceptstringGenerated from available response content types

bodyobjectChanges to a payment agreement that need the payer's approval. Include only the fields you want to change.

202Accepted. The request was validated and accepted for background processing. Use <code>uniqueRequestId</code> to check its status.

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.

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/PaymentAgreementAsync/{paymentAgreementUID}/bilateral \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "automaticRenewal": "false",
     "endDate": "2028-06-30",
     "respondByTime": "2026-12-28T17:00:00+11:00",
     "paymentTerms": {
     "numberOfTransactionsPermitted": "1",
     "frequency": "MNTH",
     "pointInTime": "15",
     "amount": "50.00",
     "maximumAmount": "100.00",
     "agreementType": "VARI"
     }
     }'