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"}
Hand-off a PaymentIntent to a Reader
POST / v1 / terminal / readers /:id / process_payment_intent
Initiates a payment flow on a Reader. See process the payment for more details.
Parameters
- payment _ intent string Required The ID of the PaymentIntent to process on the reader.
More parameters
- process _ config object
Returns
Returns an updated Reader resource.
Response
{ "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": "2.37.2.0", "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"}