Collect inputs using a Reader
POST / v1 / terminal / readers /:id / collect_inputs
Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Parameters
- inputs array of objects Required List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.
- metadata map 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_OXYJvwsea7PDiDHNciXRkytb", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "collect_inputs": { "inputs": [ { "type": "signature", "custom_text": { "title": "Signature", "description": "Please sign below", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "signature": { "value": null } }, { "type": "selection", "custom_text": { "title": "Selection", "description": "Please select one" }, "required": true, "selection": { "choices": [ { "style": "primary", "text": "choice_1", "id": "choice_1_id" }, { "style": "secondary", "text": "choice_2", "id": "choice_2_id" } ], "value": null } }, { "type": "email", "custom_text": { "title": "Enter your email", "description": "We'll send updates on your order and occasional deals", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "email": { "value": null } } ] }, "status": "in_progress", "type": "collect_inputs" }, "device_deploy_group": null, "device_sw_version": null, "device_type": "bbpos_wisepos_e", "ip_address": "192.168.2.2", "label": "Blue Rabbit", "livemode": false, "location": null, "metadata": {}, "serial_number": "123-456-789", "software": null, "status": "online"}
Confirm a PaymentIntent on the Reader Preview
POST / v1 / terminal / readers /:id / confirm_payment_intent
Finalizes a payment on a Reader. See Confirming a Payment for more details.
Parameters
- payment _ intent string Required The ID of the PaymentIntent to confirm.
More parameters
- confirm _ config object Preview feature
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "collect_payment_method": { "payment_intent": "pi_1NrpbFBHO5VeT9SUiCEDMdc8" }, "status": "in_progress", "type": "confirm_payment_intent" }, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Hand off a PaymentIntent to a Reader and collect card details Preview
POST / v1 / terminal / readers /:id / collect_payment_method
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.
Parameters
- payment _ intent string Required The ID of the PaymentIntent to collect a payment method for.
More parameters
- collect _ config object
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "collect_payment_method": { "payment_intent": "pi_1NrpbFBHO5VeT9SUiCEDMdc8" }, "status": "in_progress", "type": "collect_payment_method" }, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}