Skip to main content
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

Transfer

object

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 T…

amount integer
required

Amount in %s to be transferred.

amount_reversed integer
required

Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

balance_transaction
optionalnullable

Balance transaction that describes the impact of this transfer on your account balance.

created integer (unix-time)
required

Time that this record of the transfer was first created.

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).

description string
optionalnullable

An arbitrary string attached to the object. Often useful for displaying to users.

destination
optionalnullable

ID of the Stripe account the transfer was sent to.

destination_payment
optional

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

id string
required

Unique identifier for the object.

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
required

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.

reversals TransferReversalList object
required

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

reversed boolean
required

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

source_transaction
optionalnullable

ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

source_type string
optionalnullable

The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.

transfer_group string
optionalnullable

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.