Sign in

Hand off a PaymentIntent to a Reader and collect card details

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

post/v1/terminal/readers/{reader}/collect_payment_method

Path parameters

readerstring required

Response

Successful response.

device_sw_versionstring nullable

The current software version of the reader.

device_type'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' | 'mobile_phone_reader' | 'simulated_stripe_s700' | 'simulated_stripe_s710' | 'simulated_verifone_m425' | 'simulated_verifone_p630' | 'simulated_verifone_ux700' | 'simulated_verifone_v660p' | 'simulated_wisepos_e' | 'stripe_m2' | 'stripe_s700' | 'stripe_s710' | 'verifone_P400' | 'verifone_m425' | 'verifone_p630' | 'verifone_ux700' | 'verifone_v660p' required

Device type of the reader.

idstring required

Unique identifier for the object.

ip_addressstring nullable

The local IP address of the reader.

labelstring required

Custom label given to the reader for easier identification.

last_seen_atinteger nullable

The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'terminal.reader' required

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

serial_numberstring required

Serial number of the reader.

status'offline' | 'online' nullable

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

Changes

Changed in 5 of the 51 revisions of this API.241

  • 9d681f6248d72See the full diff
    • ●

      added the new simulated_stripe_s710 enum value to the device_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_s710 enum value to the device_type response property for the response status 200

      response-property-enum-value-added

  • 62e8dc4ed8697See the full diff
    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_intent/anyOf[subschema #2: PaymentIntent]/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/confirm_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/process_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/payment_intent/anyOf[subschema #2: PaymentIntent]/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

  • 1e483c60b4807See the full diff
    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_intent/anyOf[subschema #2: PaymentIntent]/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/confirm_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/process_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/payment_intent/anyOf[subschema #2: PaymentIntent]/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

  • 7b79777e9bbd18See the full diff
    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/confirm_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/confirm_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/process_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/process_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

  • c4dc6dbe947e9See the full diff
    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/collect_payment_method/payment_method/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/confirm_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/process_payment_intent/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property action/anyOf[subschema #1: TerminalReaderReaderResourceReaderAction]/refund_payment/payment_intent/anyOf[subschema #2: PaymentIntent]/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.