AgreementService / Paginator / ListAgreementPaymentRequests

ListAgreementPaymentRequests

class AgreementService.Paginator.ListAgreementPaymentRequests

paginator = client.get_paginator('list_agreement_payment_requests')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgreementService.Client.list_agreement_payment_requests().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    partyType='string',
    agreementType='string',
    catalog='string',
    agreementId='string',
    status='VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • 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.

      • updatedAt (datetime) –

        The date and time when the payment request was last updated.

  • NextToken (string) –

    A token to resume pagination.