@sumup/sdk
    Preparing search index...

    Type Alias GetReaderCheckoutResponse

    GetReaderCheckoutResponse

    type GetReaderCheckoutResponse = {
        data: {
            card_type: "credit" | "debit" | null;
            checkout_id: string;
            client_transaction_id: string;
            created_at: string;
            installments: number | null;
            payment_failure_reason?: string | null;
            payment_status: string | null;
            payment_type: "card" | "pix";
            reader_firmware_version: string;
            reader_serial_number: string;
            status: "pending" | "successful" | "failed" | "cancelled";
            total_amount: { currency: string; minor_unit: number; value: number };
            updated_at: string;
            valid_until: string | null;
        };
    }
    Index
    data: {
        card_type: "credit" | "debit" | null;
        checkout_id: string;
        client_transaction_id: string;
        created_at: string;
        installments: number | null;
        payment_failure_reason?: string | null;
        payment_status: string | null;
        payment_type: "card" | "pix";
        reader_firmware_version: string;
        reader_serial_number: string;
        status: "pending" | "successful" | "failed" | "cancelled";
        total_amount: { currency: string; minor_unit: number; value: number };
        updated_at: string;
        valid_until: string | null;
    }

    Type Declaration

    • card_type: "credit" | "debit" | null

      Type of the card. Required for some countries

    • checkout_id: string

      Unique identifier for the checkout

    • client_transaction_id: string

      Client transaction identifier associated with the checkout

    • created_at: string

      Checkout creation timestamp

    • installments: number | null

      Number of installments for the transaction. Required for some countries.

    • Optionalpayment_failure_reason?: string | null

      Payment failure reason

    • payment_status: string | null

      Payment status from payments v2 event

    • payment_type: "card" | "pix"

      Type of the payment. Required for some countries

    • reader_firmware_version: string

      Reader firmware version

    • reader_serial_number: string

      Device serial number

    • status: "pending" | "successful" | "failed" | "cancelled"

      Current status of the checkout

    • total_amount: { currency: string; minor_unit: number; value: number }

      Money

      Amount structure.

      The amount is represented as an integer value altogether with the currency and the minor unit.

      For example, EUR 1.00 is represented as value 100 with minor unit of 2.

      • currency: string

        Currency ISO 4217 code

      • minor_unit: number

        The minor units of the currency. It represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit is 0.

      • value: number

        Integer value of the amount.

    • updated_at: string

      Checkout last update timestamp

    • valid_until: string | null

      Checkout expiration timestamp. After this time, the checkout will be automatically cancelled.