Create a transfer

Changed on

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.

post/v1/transfers

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/transfers
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

amountinteger

A positive integer in cents (or local equivalent) representing how much to transfer.

currencystring currency required

Three-letter ISO code for currency in lowercase. Must be a supported currency.

descriptionstring

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

destinationstring required

The ID of a connected Stripe account. <a href="/docs/connect/separate-charges-and-transfers">See the Connect documentation</a> for details.

expandstring[]

Specifies which fields in the response should be expanded.

metadataobject

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.

source_transactionstring

You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.

source_type'bank_account' | 'card' | 'fpx'

The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

transfer_groupstring

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Response

Successful response.

amountinteger required

Amount in cents (or local equivalent) to be transferred.

amount_reversedinteger required

Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

createdinteger required

Time that this record of the transfer was first created.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

descriptionstring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'transfer' required

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

reversedboolean required

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

source_typestring

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

transfer_groupstring nullable

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.