Schema2020-08-27object

transfer

A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://stripe.com/docs/transfer-payout-split). Related guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers).

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

TransferReversalList

object

A list of reversals that have been applied to the transfer.

data array

required

Details about each object.

has_more boolean

required

True if this list has another page of items after this one that can be fetched.

object string

required

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Allowed: "list"

url string

required

The URL where this list can be accessed.

maxLength:5000

Root JSON Schema

{"description":"A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers).","properties":{"amount":{"description":"Amount in %s to be transferred.","type":"integer"},"amount_reversed":{"description":"Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).","type":"integer"},"balance_transaction":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/balance_transaction"}],"description":"Balance transaction that describes the impact of this transfer on your account balance.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/balance_transaction"}]}},"created":{"description":"Time that this record of the transfer was first created.","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"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"destination":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/account"}],"description":"ID of the Stripe account the transfer was sent to.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/account"}]}},"destination_payment":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/charge"}],"description":"If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/charge"}]}},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"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.","type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["transfer"],"type":"string"},"reversals":{"description":"A list of reversals that have been applied to the transfer.","properties":{"data":{"description":"Details about each object.","items":{"$ref":"#/components/schemas/transfer_reversal"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"TransferReversalList","type":"object","x-expandableFields":["data"]},"reversed":{"description":"Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.","type":"boolean"},"source_transaction":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/charge"}],"description":"ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/charge"}]}},"source_type":{"description":"The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.","maxLength":5000,"nullable":true,"type":"string"},"transfer_group":{"description":"A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details.","maxLength":5000,"nullable":true,"type":"string"}},"required":["amount","amount_reversed","created","currency","id","livemode","metadata","object","reversals","reversed"],"title":"Transfer","type":"object","x-expandableFields":["balance_transaction","destination","destination_payment","reversals","source_transaction"],"x-resourceId":"transfer"}