Skip to content

PaymentRequestSummary

Source code in docs_src/capo_marketplace_agreement/types/payment_request_summary.py
class PaymentRequestSummary(TypedDict, closed=True):
    payment_request_id: NotRequired[
        "capo_marketplace_agreement.types.payment_request_id.PaymentRequestId"
    ]
    """<p>The unique identifier of the payment request.</p>"""
    agreement_id: NotRequired[
        "capo_marketplace_agreement.types.agreement_id.AgreementId"
    ]
    """<p>The unique identifier of the agreement associated with this payment request.</p>"""
    status: NotRequired[
        "capo_marketplace_agreement.types.payment_request_status.PaymentRequestStatus"
    ]
    """<p>The current status of the payment request. Possible values include <code>VALIDATING</code>, <code>VALIDATION_FAILED</code>, <code>PENDING_APPROVAL</code>, <code>APPROVED</code>, <code>REJECTED</code>, and <code>CANCELLED</code>.</p>"""
    name: NotRequired[
        "capo_marketplace_agreement.types.payment_request_name.PaymentRequestName"
    ]
    """<p>The descriptive name of the payment request.</p>"""
    charge_id: NotRequired["capo_marketplace_agreement.types.charge_id.ChargeId"]
    """<p>The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.</p>"""
    charge_amount: NotRequired[
        "capo_marketplace_agreement.types.positive_amount_upto8_decimals.PositiveAmountUpto8Decimals"
    ]
    """<p>The amount charged or to be charged to the buyer.</p>"""
    currency_code: NotRequired[
        "capo_marketplace_agreement.types.currency_code.CurrencyCode"
    ]
    """<p>The currency code for the charge amount.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the payment request was created.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the payment request was last updated.</p>"""

agreement_id instance-attribute

agreement_id: NotRequired[AgreementId]

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

charge_amount instance-attribute

charge_amount: NotRequired[PositiveAmountUpto8Decimals]

The amount charged or to be charged to the buyer.

charge_id instance-attribute

charge_id: NotRequired[ChargeId]

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

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time when the payment request was created.

currency_code instance-attribute

currency_code: NotRequired[CurrencyCode]

The currency code for the charge amount.

name instance-attribute

name: NotRequired[PaymentRequestName]

The descriptive name of the payment request.

payment_request_id instance-attribute

payment_request_id: NotRequired[PaymentRequestId]

The unique identifier of the payment request.

status instance-attribute

status: NotRequired[PaymentRequestStatus]

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

updated_at instance-attribute

updated_at: NotRequired[datetime]

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