Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a VariablePaymentTerm. The payment request is created in PENDING_APPROVAL status, at which point the buyer can accept or reject it.

The agreement must be active and have a VariablePaymentTerm to support payment requests. The chargeAmount must not exceed the remaining available balance under the VariablePaymentTerm maxTotalChargeAmount.

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

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.SendAgreementPaymentRequest' required

Request body

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

agreementIdstring required

The unique identifier of the agreement for which the payment request is being submitted. Use <code>GetAgreementTerms</code> to retrieve agreement term details.

termIdstring required

The unique identifier of the <code>VariablePaymentTerm</code> for the agreement that the payment request is being sent for.

namestring required

A descriptive name for the payment request (5-64 characters).

chargeAmountstring required
<p>The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.</p> <note> <p>A <code>ValidationException</code> is returned if the <code>chargeAmount</code> exceeds the available balance, if the agreement doesn't have an active <code>VariablePaymentTerm</code>, or if the <code>termId</code> is invalid.</p> </note>
descriptionstring password

An optional detailed description of the payment request (1-2000 characters).

Response

Success

paymentRequestIdstring

The unique identifier for the sent payment request.

agreementIdstring

The agreement identifier for this payment request.

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

The current status of the payment request. The initial status is <code>PENDING_APPROVAL</code>.

namestring

The descriptive name of the payment request.

descriptionstring password

The detailed description of the payment request, if provided.

chargeAmountstring

The amount being charged to the buyer.

currencyCodestring

The currency code for the charge amount (e.g., <code>USD</code>).

createdAtstring date-time

The time when the payment request was created.