Unilateral Amendment Async

PATCH

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

The purpose of this endpoint is to asynchronously amend a payment agreement that does not require approval from the Payer. 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 do not need the payer's approval. Only the payee details and the agreement descriptions can be changed unilaterally.

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}/unilateral \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "description": "Monthly subscription for ABC Corp services",
     "shortDescription": "ABC Corp subscription",
     "payeeDetails": {
     "payeeType": "ORGN",
     "payeeLinkedBsb": "062000",
     "payeeLinkedAccount": "12345678",
     "payeeLinkedPayId": "[email protected]",
     "payeeLinkedPayIdType": "Email",
     "payeeAccountName": "ABC Corp Pty Ltd",
     "ultimatePayee": "ABC Corp",
     "payeeMCCCode": "5968",
     "ultimatePayeeMCCCode": "5968"
     }
     }'