POST /v1/tax/transactions/create_reversal
Partially or fully reverses a previously created Transaction.
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 |
|---|---|---|---|
line_items[] |
Array | No |
The line item amounts to reverse. |
line_items[].amount |
Integer | Yes | |
line_items[].quantity |
Integer | No | |
line_items[].metadata |
Object | No | |
line_items[].original_line_item |
String | Yes | |
line_items[].reference |
String | Yes | |
line_items[].amount_tax |
Integer | Yes | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
original_transaction |
String | Yes |
The ID of the Transaction to partially or fully reverse. |
flat_amount |
Integer | No |
A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes. |
shipping_cost |
Object | No |
The shipping cost to reverse. |
shipping_cost.amount |
Integer | Yes | |
shipping_cost.amount_tax |
Integer | Yes | |
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 |
mode |
String | Yes |
If Possible values:
|
reference |
String | Yes |
A custom identifier for this reversal, such as |
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.