Schema2020-08-27object

transfer_reversal

[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

TransferReversal

object

amount integer

required

Amount, in %s.

balance_transaction

optionalnullable

Balance transaction that describes the impact on your account balance.

created integer (unix-time)

required

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

currency string

required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

destination_payment_refund

optionalnullable

Linked payment refund for the transfer reversal.

id string

required

Unique identifier for the object.

maxLength:5000

metadata object

optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string

required

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

Allowed: "transfer_reversal"

source_refund

optionalnullable

ID of the refund responsible for the transfer reversal.

transfer

required

ID of the transfer that was reversed.

Root JSON Schema

{"description":"[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).","properties":{"amount":{"description":"Amount, in %s.","type":"integer"},"balance_transaction":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/balance_transaction"}],"description":"Balance transaction that describes the impact on your account balance.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/balance_transaction"}]}},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"destination_payment_refund":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/refund"}],"description":"Linked payment refund for the transfer reversal.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/refund"}]}},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["transfer_reversal"],"type":"string"},"source_refund":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/refund"}],"description":"ID of the refund responsible for the transfer reversal.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/refund"}]}},"transfer":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/transfer"}],"description":"ID of the transfer that was reversed.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/transfer"}]}}},"required":["amount","created","currency","id","object","transfer"],"title":"TransferReversal","type":"object","x-expandableFields":["balance_transaction","destination_payment_refund","source_refund","transfer"],"x-resourceId":"transfer_reversal"}