AgreementService / Client / send_agreement_payment_request

send_agreement_payment_request

AgreementService.Client.send_agreement_payment_request(**kwargs)

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.send_agreement_payment_request(
    clientToken='string',
    agreementId='string',
    termId='string',
    name='string',
    chargeAmount='string',
    description='string'
)
Parameters:

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • agreementId (string) –

    [REQUIRED]

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

  • termId (string) –

    [REQUIRED]

    The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.

  • name (string) –

    [REQUIRED]

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

  • chargeAmount (string) –

    [REQUIRED]

    The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.

    Note

    A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn’t have an active VariablePaymentTerm, or if the termId is invalid.

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

Return type:

dict

Returns:

Response Syntax

{
    'paymentRequestId': 'string',
    'agreementId': 'string',
    'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    'name': 'string',
    'description': 'string',
    'chargeAmount': 'string',
    'currencyCode': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • paymentRequestId (string) –

      The unique identifier for the sent payment request.

    • agreementId (string) –

      The agreement identifier for this payment request.

    • status (string) –

      The current status of the payment request. The initial status is PENDING_APPROVAL.

    • name (string) –

      The descriptive name of the payment request.

    • description (string) –

      The detailed description of the payment request, if provided.

    • chargeAmount (string) –

      The amount being charged to the buyer.

    • currencyCode (string) –

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

    • createdAt (datetime) –

      The time when the payment request was created, in ISO 8601 format.

Exceptions

  • AgreementService.Client.exceptions.ValidationException

  • AgreementService.Client.exceptions.AccessDeniedException

  • AgreementService.Client.exceptions.ResourceNotFoundException

  • AgreementService.Client.exceptions.ThrottlingException

  • AgreementService.Client.exceptions.InternalServerException

  • AgreementService.Client.exceptions.ConflictException