AgreementService / Client / list_agreement_payment_requests

list_agreement_payment_requests

AgreementService.Client.list_agreement_payment_requests(**kwargs)

Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.

Note

PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 50) and nextToken parameters.

See also: AWS API Documentation

Request Syntax

response = client.list_agreement_payment_requests(
    partyType='string',
    agreementType='string',
    catalog='string',
    agreementId='string',
    status='VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    maxResults=123,
    nextToken='string'
)

Parameters:

• partyType (string) –

  [REQUIRED]

  The party type for the payment requests. Required parameter. Use Proposer to list payment requests where you are the seller, or Acceptor to list payment requests where you are the buyer.

• agreementType (string) – An optional parameter to list payment requests by agreement type (e.g., PurchaseAgreement).

• catalog (string) – An optional parameter to list payment requests by catalog (e.g., AWSMarketplace).

• agreementId (string) – An optional parameter to list payment requests for a specific agreement.

• status (string) – An optional parameter to list payment requests by status. Valid values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.

• maxResults (integer) – The maximum number of payment requests to return in a single response (1-50). Default is 50.

• nextToken (string) – A token to specify where to start pagination. Use the nextToken value from a previous response to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'paymentRequestId': 'string',
            'agreementId': 'string',
            'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
            'name': 'string',
            'chargeId': 'string',
            'chargeAmount': 'string',
            'currencyCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    A token to retrieve the next page of results. If null, there are no more results to retrieve.

  • items (list) –

    An array of PaymentRequestSummary objects containing summary information about each payment request.

    • (dict) –

      Summary view of a payment request.

      • paymentRequestId (string) –

        The unique identifier of the payment request.

      • agreementId (string) –

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

      • status (string) –

        The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.

      • name (string) –

        The descriptive name of the payment request.

      • chargeId (string) –

        The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.

      • chargeAmount (string) –

        The amount charged or to be charged to the buyer.

      • currencyCode (string) –

        The currency code for the charge amount.

      • createdAt (datetime) –

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

      • updatedAt (datetime) –

        The date and time when the payment request was last updated, in ISO 8601 format.

Exceptions

• AgreementService.Client.exceptions.ValidationException

• AgreementService.Client.exceptions.AccessDeniedException

• AgreementService.Client.exceptions.ThrottlingException

• AgreementService.Client.exceptions.InternalServerException