POST /v1/terminal/readers/{reader}/refund_payment
Initiates a refund on a Reader
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
reader |
String | Yes |
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 |
ID of the PaymentIntent to refund. |
amount |
Integer | No |
A positive integer in cents representing how much of this charge to refund. |
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 |
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 |
ID of the Charge to refund. |
refund_payment_config |
Object | No |
Configuration overrides |
refund_payment_config.enable_customer_cancellation |
Boolean | No |
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.