Initiates a payment flow on a Reader.
Parameters
- payment_
intentstringRequired PaymentIntent ID
More parameters
- process_
configobject Configuration overrides
- process_config.
allow_ redisplayenum 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 valuesalways
Use
always
to indicate that this payment method can always be shown to a customer in a checkout flow.limited
Use
limited
to 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.unspecified
This is the default value for payment methods where
allow_
wasn’t set.redisplay - process_config.
enable_ customer_ cancellationboolean Enables cancel button on transaction screens.
- process_config.
return_ urlstringPreview feature The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
- process_config.
skip_ tippingboolean Override showing a tipping selection screen on this transaction.
- process_config.
tippingobject Tipping configuration for this transaction.
- process_config.
tipping. amount_ eligibleinteger 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).
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"}