The Reader object 

Attributes

• idstring

  Unique identifier for the object.

• device_typeenum

  Type of reader, one of bbpos_wisepad3, stripe_m2, stripe_s700, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader.

  Possible enum values

  bbpos_chipper2x

  bbpos_wisepad3

  bbpos_wisepos_e

  mobile_phone_reader

  simulated_wisepos_e

  stripe_m2

  stripe_s700

  verifone_P400

• labelstring

  Custom label given to the reader for easier identification.

• locationnullable stringExpandable

  The location identifier of the reader.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• serial_numberstring

  Serial number of the reader.

• statusnullable enum

  The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

  Possible enum values

  offline

  online

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• actionnullable object

  The most recent action performed by the reader.

  Hide child attributes

  • action.collect_inputsnullable objectPreview feature

    Payload required to collect inputs using the reader. Only present if type is collect_inputs.

    Hide child attributes

    • action.collect_inputs.inputsarray of objects

      List of inputs to be collected.

      Hide child attributes

      • action.collect_inputs.inputs.custom_textnullable object

        Default text of input being collected.

        Hide child attributes

        • action.collect_inputs.inputs.custom_text.descriptionnullable string

          Customize the default description for this input

        • action.collect_inputs.inputs.custom_text.skip_buttonnullable string

          Customize the default label for this input’s skip button

        • action.collect_inputs.inputs.custom_text.submit_buttonnullable string

          Customize the default label for this input’s submit button

        • action.collect_inputs.inputs.custom_text.titlenullable string

          Customize the default title for this input

      • action.collect_inputs.inputs.emailnullable object

        Email form value collected.

        Hide child attributes

        • action.collect_inputs.inputs.email.valuenullable string

          The collected email address

      • action.collect_inputs.inputs.numericnullable object

        Numeric form value collected.

        Hide child attributes

        • action.collect_inputs.inputs.numeric.valuenullable string

          The collected number

      • action.collect_inputs.inputs.phonenullable object

        Phone form value collected.

        Hide child attributes

        • action.collect_inputs.inputs.phone.valuenullable string

          The collected phone number

      • action.collect_inputs.inputs.requirednullable boolean

        Indicate that this input is required, disabling the skip button.

      • action.collect_inputs.inputs.selectionnullable object

        Selection form choices being collected. Values are present if collection is complete.

        Hide child attributes

        • action.collect_inputs.inputs.selection.choicesarray of objects

          List of possible choices to be selected

          Hide child attributes

          • action.collect_inputs.inputs.selection.choices.stylenullable enum

            The button style for the choice

          • action.collect_inputs.inputs.selection.choices.valuestring

            A value to be selected

        • action.collect_inputs.inputs.selection.valuenullable string

          The value of the selected choice

      • action.collect_inputs.inputs.signaturenullable object

        Signature form value collected.

        Hide child attributes

        • action.collect_inputs.inputs.signature.valuenullable string

          The File ID of a collected signature image

      • action.collect_inputs.inputs.skippednullable boolean

        Indicate that this input was skipped by the user.

      • action.collect_inputs.inputs.textnullable object

        Text form value collected.

        Hide child attributes

        • action.collect_inputs.inputs.text.valuenullable string

          The collected text value

      • action.collect_inputs.inputs.togglesnullable array of objects

        List of toggles being collected. Values are present if collection is complete.

        Hide child attributes

        • action.collect_inputs.inputs.toggles.default_valuenullable enum

          The toggle’s default value

        • action.collect_inputs.inputs.toggles.descriptionnullable string

          The toggle’s description text

        • action.collect_inputs.inputs.toggles.titlenullable string

          The toggle’s title text

        • action.collect_inputs.inputs.toggles.valuenullable enum

          The toggle’s collected value

      • action.collect_inputs.inputs.typeenum

        Type of input being collected.

        Possible enum values

        email

        numeric

        phone

        selection

        signature

        text

    • action.collect_inputs.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • action.failure_codenullable string

    Failure code, only set if status is failed.

  • action.failure_messagenullable string

    Detailed failure message, only set if status is failed.

  • action.process_payment_intentnullable object

    Payload required to process a PaymentIntent. Only present if type is process_payment_intent.

    Hide child attributes

    • action.process_payment_intent.payment_intentstringExpandable

      Most recent PaymentIntent processed by the reader.

    • action.process_payment_intent.process_confignullable object

      Per-transaction overrides of Terminal reader configurations.

      Hide child attributes

      • action.process_payment_intent.process_config.enable_customer_cancellationnullable boolean

        Enable customer initiated cancellation when processing this payment.

      • action.process_payment_intent.process_config.return_urlnullable stringPreview feature

        If the customer does not abandon authenticating the payment, they will be redirected to this specified URL after completion.

      • action.process_payment_intent.process_config.skip_tippingnullable boolean

        Override showing a tipping selection screen on this transaction.

      • action.process_payment_intent.process_config.tippingnullable object

        Tipping configuration for this transaction.

        Hide child attributes

        • action.process_payment_intent.process_config.tipping.amount_eligiblenullable integer

          Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).

  • action.process_setup_intentnullable object

    Payload required to process a SetupIntent. Only present if type is process_setup_intent.

    Hide child attributes

    • action.process_setup_intent.generated_cardnullable string

      ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.

    • action.process_setup_intent.process_confignullable object

      Configuration for the reader to process the SetupIntent.

      Hide child attributes

      • action.process_setup_intent.process_config.enable_customer_cancellationnullable boolean

        Enable customer initiated cancellation when processing this SetupIntent.

    • action.process_setup_intent.setup_intentstringExpandable

      Most recent SetupIntent processed by the reader.

  • action.refund_paymentnullable object

    Payload required to refund a payment. Only present if type is refund_payment.

    Hide child attributes

    • action.refund_payment.amountnullable integer

      The amount being refunded.

    • action.refund_payment.chargenullable stringExpandable

      Charge that is being refunded.

    • action.refund_payment.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • action.refund_payment.payment_intentnullable stringExpandable

      Payment intent that is being refunded.

    • action.refund_payment.reasonnullable enum

      The reason for the refund.

      Possible enum values

      duplicate

      fraudulent

      requested_by_customer

    • action.refund_payment.refundnullable stringExpandable

      Unique identifier for the refund object.

    • action.refund_payment.refund_application_feenullable boolean

      Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

    • action.refund_payment.refund_payment_confignullable object

      Per-transaction overrides of Terminal reader configurations.

      Hide child attributes

      • action.refund_payment.refund_payment_config.enable_customer_cancellationnullable boolean

        Enable customer initiated cancellation when refunding this payment.

    • action.refund_payment.reverse_transfernullable boolean

      Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

  • action.set_reader_displaynullable object

    Payload required to set the reader display. Only present if type is set_reader_display.

    Hide child attributes

    • action.set_reader_display.cartnullable object

      Cart object to be displayed by the reader.

      Hide child attributes

      • action.set_reader_display.cart.currencyenum

        Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • action.set_reader_display.cart.line_itemsarray of objects

        List of line items in the cart.

        Hide child attributes

        • action.set_reader_display.cart.line_items.amountinteger

          The amount of the line item. A positive integer in the smallest currency unit.

        • action.set_reader_display.cart.line_items.descriptionstring

          Description of the line item.

        • action.set_reader_display.cart.line_items.quantityinteger

          The quantity of the line item.

      • action.set_reader_display.cart.taxnullable integer

        Tax amount for the entire cart. A positive integer in the smallest currency unit.

      • action.set_reader_display.cart.totalinteger

        Total amount for the entire cart, including tax. A positive integer in the smallest currency unit.

    • action.set_reader_display.typeenum

      Type of information to be displayed by the reader.

      Possible enum values

      cart

  • action.statusenum

    Status of the action performed by the reader.

    Possible enum values

    failed Reader action completed with a failed outcome.

    in_progress Reader action is currently active on the Reader.

    succeeded Reader action completed with a successful outcome.

  • action.typeenum

    Type of action performed by the reader.

    Possible enum values

    collect_inputs Reader action to collect customer input.

    process_payment_intent Reader action to process a PaymentIntent.

    process_setup_intent Reader action to process a SetupIntent.

    refund_payment Reader action to refund a payment.

    set_reader_display Reader action to display information such as shopping cart details.

• device_sw_versionnullable string

  The current software version of the reader.

• ip_addressnullable string

  The local IP address of the reader.

• last_seen_atnullable integerPreview feature

  The last time this reader reported to Stripe backend.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.