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
Retrieve a transfer
GET / v1 / transfers /:id
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
Parameters
No parameters.
Returns
Returns a transfer object if a valid identifier was provided, and raises an error otherwise.
Response