Create a reversal Transaction

Partially or fully reverses a previously created Transaction.

post/v1/tax/transactions/create_reversal

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/tax/transactions/create_reversal
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customerstring nullable

The ID of an existing Customer used for the resource.

idstring required

Unique identifier for the transaction.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

object'tax.transaction' required

String representing the object's type. Objects of the same type share the same value.

posted_atinteger required

The Unix timestamp representing when the tax liability is assumed or reduced.

referencestring required

A custom unique identifier, such as 'myOrder_123'.

tax_dateinteger required

The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window.

type'reversal' | 'transaction' required

If reversal, this transaction reverses an earlier transaction.

Changes

No operation changes found yet. Some revisions have not been checked.