Create a transfer

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.

Returns

Returns a transfer object if there were no initial errors with the transfer creation (e.g., insufficient funds).

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, optional) An arbitrary string attached to the object. Often useful for displaying to users.

• metadata (object, optional) 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_transaction (string, optional) 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 (string, optional) The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

• transfer_group (string, optional) A string that identifies this transaction as part of a group. See the Connect documentation for details.

curl https://api.stripe.com/v1/transfers \
  -u "<<YOUR_SECRET_KEY>>" \
  -d amount=400 \
  -d currency=usd \
  -d destination={{ACCOUNT_ID}} \
  -d transfer_group=ORDER_95

Response

{
  "id": "tr_1MiN3gLkdIwHu7ixNCZvFdgA",
  "object": "transfer",
  "amount": 400,
  "amount_reversed": 0,
  "balance_transaction": "txn_1MiN3gLkdIwHu7ixxapQrznl",
  "created": 1678043844,
  "currency": "usd",
  "description": null,
  "destination": "acct_1MTfjCQ9PRzxEwkZ",
  "destination_payment": "py_1MiN3gQ9PRzxEwkZWTPGNq9o",
  "livemode": false,
  "metadata": {},
  "reversals": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/transfers/tr_1MiN3gLkdIwHu7ixNCZvFdgA/reversals"
  },
  "reversed": false,
  "source_transaction": null,
  "source_type": "card",
  "transfer_group": "ORDER_95"
}