Initiates an input collection flow on a Reader.
Parameters
- inputsarray of objectsRequired
List of inputs to be collected using 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. 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.
{ "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"}Finalizes a payment on a Reader.
Parameters
- payment_
intentstringRequired PaymentIntent ID.
More parameters
- confirm_
configobjectPreview feature
Returns
Returns an updated Reader resource.
{ "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": "", "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"}Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Parameters
- payment_
intentstringRequired PaymentIntent ID.
More parameters
- collect_
configobject
Returns
Returns an updated Reader resource.
{ "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": "", "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"}Initiates a payment flow on a Reader.
Parameters
- payment_
intentstringRequired PaymentIntent ID
More parameters
- process_
configobject
Returns
Returns an updated Reader resource.
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "process_payment_intent": { "payment_intent": "pi_3NtEKRLkdIwHu7ix3crEirSx" }, "status": "in_progress", "type": "process_payment_intent" }, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1695408232226, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}Initiates a setup intent flow on a Reader.
Parameters
- allow_
redisplayenumRequired This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
Possible enum valuesalwaysUse
alwaysto indicate that this payment method can always be shown to a customer in a checkout flow.limitedUse
limitedto indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.unspecifiedThis is the default value for payment methods where
allow_wasn’t set.redisplay - setup_
intentstringRequired SetupIntent ID
More parameters
- process_
configobject
Returns
Returns an updated Reader resource.
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "process_setup_intent": { "setup_intent": "seti_1NtEXHLkdIwHu7ixcBcUmqfe" }, "status": "in_progress", "type": "process_setup_intent" }, "device_sw_version": "", "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"}- Need help? Contact Support.
- Join our early access program.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc