GetReaderCheckoutResponse

Fields

  • dataobjectrequired
    Show 14 properties
    • card_typestringrequirednullable
      Options:"credit""debit"null

      Type of the card, or null when no card type was specified.

    • checkout_idstringrequired
      format: uuid

      Unique identifier for the checkout

    • client_transaction_idstringrequired

      Client transaction identifier associated with the checkout

    • created_atstringrequired
      format: date-time

      Checkout creation timestamp

    • installmentsintegerrequirednullable

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

    • payment_failure_reasonstringrequirednullable

      Reason for the payment failure, or null when no failure reason is available.

    • payment_statusstringrequirednullable

      Status of the payment, or null when no payment status is available.

    • payment_typestringrequired
      Options:"card""pix"

      Type of the payment. Required for some countries

    • Reader firmware version

    • reader_serial_numberstringrequired

      Device serial number

    • statusstringrequired
      Options:"pending""successful""failed""cancelled"

      Current status of the checkout

    • total_amountobjectrequired

      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.

      Example: {"currency":"EUR","minor_unit":2,"value":1000}

      Show 3 properties
      • currencystringrequired

        Currency ISO 4217 code

        Example: "EUR"

      • minor_unitintegerrequired
        minimum: 0

        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.

        Example: 2

      • valueintegerrequired
        minimum: 0

        Integer value of the amount.

        Example: 1000

    • updated_atstringrequired
      format: date-time

      Checkout last update timestamp

    • valid_untilstringrequirednullable
      format: date-time

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

Type to search…