POST /v1/terminal/refunds

Internal endpoint for terminal use to create a refund for a card_present charge. This endpoint only supports card_present payment method types (excludes interac_present).

You can optionally refund only part of a charge.

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`payment_intent`	String	No	The identifier of the PaymentIntent to refund.
`amount`	Integer	No	A positive integer in the smallest currency unit representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`metadata`	Object	No	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`.
`reason`	String	No	String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms. Valid values: `"duplicate"` `"requested_by_customer"` `"fraudulent"`
`reverse_transfer`	Boolean	No	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.
`refund_application_fee`	Boolean	No	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.
`charge`	String	No	The identifier of the charge to refund.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.