Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.

Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the payment request is in any other status.

post/#X-Amz-Target=AWSMPCommerceService_v20200301.CancelAgreementPaymentRequest

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.CancelAgreementPaymentRequest' required

Request body

paymentRequestIdstring required

The unique identifier of the payment request to cancel.

agreementIdstring required

The unique identifier of the agreement associated with the payment request.

Response

Success

paymentRequestIdstring

The unique identifier of the cancelled payment request.

agreementIdstring

The unique identifier of the agreement associated with this payment request.

status'VALIDATING' | 'VALIDATION_FAILED' | 'PENDING_APPROVAL' | 'APPROVED' | 'REJECTED' | 'CANCELLED'

The updated status of the payment request, which is <code>CANCELLED</code>.

namestring

The descriptive name of the payment request.

descriptionstring password

The detailed description of the payment request, if provided.

chargeAmountstring

The amount that was requested to be charged.

currencyCodestring

The currency code for the charge amount.

createdAtstring date-time

The date and time when the payment request was originally created.

updatedAtstring date-time

The date and time when the payment request was cancelled.