Refund a Charge or a PaymentIntent in-person 

Terminal
Reader
Refund a Charge or a PaymentIntent in-person

Initiates a refund on a Reader

Parameters

  • amountinteger

    A positive integer in cents representing how much of this charge to refund.

  • chargestring

    ID of the Charge to refund.

  • 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.

  • payment_intentstring

    ID of the PaymentIntent to refund.

  • refund_application_feebooleanConnect 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_transferbooleanConnect 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_configobject

    Configuration overrides

    • refund_payment_config.enable_customer_cancellationboolean

      Enables cancel button on transaction screens.

Returns

Returns an updated Reader resource

POST /v1/terminal/readers/:id/refund_payment
curl https://api.stripe.com/v1/terminal/readers/tmr_njDFG9Z5k7y7KeQI8RmZYDYT/refund_payment \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d payment_intent=pi_1NrpbFBHO5VeT9SUiCEDMdc8
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"
}