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"}
Reload a Gift Card on a Reader
POST / v1 / terminal / readers /:id / reload_gift_card
Initiates a gift card reload flow on a Reader by adding the specified amount to its balance.
Parameters
- amount integer Required The amount to add to the gift card balance, in the smallest currency unit.
- brand enum Required The brand of the gift card. Possible enum values
svsSVS gift card. - currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
More parameters
- on _ behalf _ of string
Returns
Returns an updated Reader resource.
cURL
Response
{ "id": "tmr_GkoLBwI8ngxx08", "object": "terminal.reader", "action": { "api_error": null, "failure_code": null, "failure_message": null, "reload_gift_card": {}, "status": "in_progress", "type": "reload_gift_card" }, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "simulated-wpe-e448e0d1-388f-40cd-b30f-ca82de03ced6", "last_seen_at": 1783521710620, "livemode": false, "location": "tml_GczOlAw6Yx2UMe", "metadata": {}, "serial_number": "e448e0d1-388f-40cd-b30f-ca82de03ced6", "status": "online"}
Set reader display
POST / v1 / terminal / readers /:id / set_reader_display
Sets the reader display to show cart details.
Parameters
- type enum Required Type of information to display. Only
cartis currently supported. - cart object Cart details to display on the reader screen, including line items, amounts, and currency.
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "set_reader_display": { "cart": { "currency": "usd", "line_items": [ { "amount": 5100, "description": "Red t-shirt", "quantity": 1 } ], "tax": 100, "total": 5200 }, "type": "cart" }, "status": "in_progress", "type": "set_reader_display" }, "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"}