Hand-off a SetupIntent to a Reader

POST / v1 / terminal / readers /:id / process_setup_intent

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

Parameters

• allow _ redisplay enum Required 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 values always 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_redisplay wasn’t set.
• setup _ intent string Required The ID of the SetupIntent 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_setup_intent": { "setup_intent": "seti_1NtEXHLkdIwHu7ixcBcUmqfe" }, "status": "in_progress", "type": "process_setup_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"}

Print content on a reader

POST / v1 / terminal / readers /:id / print_content

To print content on a reader’s embedded printer, send a multipart/form-data request with the PNG or the related setting image file to print. Use black and white images for best results.

See the integration guide for more details.

NOTE: This endpoint lives on the files.stripe.com subdomain instead of api.stripe.com.

Parameters

• image map Required The image file to print. Must be a PNG or the related setting not exceeding 100 kB in size. Use black and white images for best results. Specifications must follow RFC 2388, which defines file transfers for the multipart/form-data protocol.
• type enum Required The type of content to print. Currently supports image. Possible enum values image Print an image on the reader’s embedded printer.

Returns

Returns an updated Reader resource.

cURL

Response

{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "print_content": { "image": { "created_at": 1748971913, "filename": "image.png", "size": 15864, "type": "png" }, "type": "image" }, "status": "in_progress", "type": "print_content" }, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1695166525506, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}

Refund a Charge or a PaymentIntent in-person

POST / v1 / terminal / readers /:id / refund_payment

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

Parameters

• amount integer A positive integer in cents representing how much of this charge to refund.
• charge string ID of the Charge to refund.
• 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.
• payment _ intent string ID of the PaymentIntent to refund.
• refund _ application _ fee boolean Connect only Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
• reverse _ transfer boolean Connect only Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

More parameters

• refund _ payment _ config object

Returns

Returns an updated Reader resource

Response

{ "id": "tmr_njDFG9Z5k7y7KeQI8RmZYDYT", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "refund_payment": { "payment_intent": "pi_1NrpbFBHO5VeT9SUiCEDMdc8", "amount": 1000 }, "status": "in_progress", "type": "refund_payment" }, "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"}