The Transfer object
Attributes
- id string Unique identifier for the object.
- amount integer Amount in the smallest currency unit to be transferred.
- currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description nullable string An arbitrary string attached to the object. Often useful for displaying to users.
- destination nullable string Expandable ID of the Stripe account the transfer was sent to.
- metadata map 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.
More attributes
- object string, value is "transfer"
- amount _ reversed integer
- balance _ transaction nullable string Expandable
- created timestamp
- destination _ payment nullable string Expandable
- livemode boolean
- reversals object
- reversed boolean
- source _ transaction nullable string Expandable
- source _ type nullable string
- transfer _ group nullable string
The Transfer object
Create a transfer
POST / v1 / transfers
To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
Parameters
- currency enum Required Three-letter ISO code for currency in lowercase. Must be a supported currency.
- destination string Required The ID of a connected Stripe account. See the Connect documentation for details.
- amount integer Required A positive integer in the smallest currency unit representing how much to transfer.
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- metadata map 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
metadata.
More parameters
- source _ transaction string
- source _ type string
- transfer _ group string
Returns
Returns a transfer object if there were no initial errors with the transfer creation (e.g., insufficient funds).
Response
Update a transfer
POST / v1 / transfers /:id
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
Parameters
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- metadata map 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
metadata.
Returns
Returns the transfer object if the update succeeded. This call will raise an error if update parameters are invalid.
Response