Recall a Payment Agreement

PATCH

https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}

This endpoint is used to recall a pending payment agreement before it is approved by the payer.

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

actionIdstringUnique ID of the pending (unapproved) action to recall. This ID is assigned when a new payment agreement is created or when a bilateral amendment is made, and is returned as <code>actionIdentification</code>.

acceptstringGenerated from available response content types

200OK. The pending action was recalled.

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 or the pending action 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/PaymentAgreement/{paymentAgreementUID}/recall/{actionId} \
     --header 'accept: application/json'