Stripe: Create an Outbound Transfer

Stripe treasury.postTreasuryOutboundTransfers: arguments, response, policy and SDK examples.

Operation stripe.posttreasuryoutboundtransfers

Provider route: POST /v1/treasury/outbound_transfers. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["treasury"]["postTreasuryOutboundTransfers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.treasury.postTreasuryOutboundTransfers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.treasury.post_treasury_outbound_transfers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Required within parent	Additional keys: not allowed
`body.amount`	integer	Required within parent	Amount (in cents) to be transferred.
`body.currency`	string	Required within parent	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). Format: currency
`body.description`	string	Optional	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`body.destination_payment_method`	string	Optional	The PaymentMethod to use as the payment instrument for the OutboundTransfer. Maximum length: 5000
`body.destination_payment_method_data`	object	Optional	Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
`body.destination_payment_method_data.financial_account`	string	Optional
`body.destination_payment_method_data.type`	string	Required within parent	One of: financial_account
`body.destination_payment_method_options`	object	Optional	Hash describing payment method configuration details.
`body.destination_payment_method_options.us_bank_account`	JSON	Optional
`body.destination_payment_method_options.us_bank_account (anyOf 1)`	object	Alternative
`body.destination_payment_method_options.us_bank_account (anyOf 1).network`	string	Optional	One of: ach, us_domestic_wire
`body.destination_payment_method_options.us_bank_account (anyOf 2)`	string	Alternative	One of:
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.financial_account`	string	Required within parent	The FinancialAccount to pull funds from.
`body.metadata`	object	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`. Additional keys: see wildcard field
`body.metadata.*`	string	Additional keys
`body.statement_descriptor`	string	Optional	Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is “transfer”. Can only include -#.$&*, spaces, and alphanumeric characters. Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Cancel an Outbound Transfer — response body

Referenced models: Cancel an Outbound Transfer — response body

Schemas

747 more schemas are linked from the tables above, on the schema pages.

Cancel an Outbound Transfer — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://docs.stripe.com/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://docs.stripe.com/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	Amount (in cents) transferred.
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cancelable`	boolean	Required within parent	Returns `true` if the object can be canceled, and `false` otherwise.
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	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). Format: currency
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`description (anyOf 2)`	null	Alternative
`destination_payment_method`	JSON	Optional
`destination_payment_method (anyOf 1)`	string	Alternative	The PaymentMethod used as the payment instrument for an OutboundTransfer. Maximum length: 5000
`destination_payment_method (anyOf 2)`	null	Alternative
`destination_payment_method_details`	Model	Required within parent	Expand Cancel an Outbound Transfer — response body — destination payment method details
`expected_arrival_date`	JSON	Required within parent
`expected_arrival_date (anyOf 1)`	integer	Alternative	The date when funds are expected to arrive in the destination account. Format: unix-time
`expected_arrival_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`financial_account`	string	Required within parent	The FinancialAccount that funds were pulled from. Maximum length: 5000
`hosted_regulatory_receipt_url`	JSON	Optional
`hosted_regulatory_receipt_url (anyOf 1)`	string	Alternative	A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. Maximum length: 5000
`hosted_regulatory_receipt_url (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: treasury.outbound_transfer
`returned_details`	JSON	Optional
`returned_details (anyOf 1)`	JSON	Alternative	Details about a returned OutboundTransfer. Only set when the status is `returned`.
`returned_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an Outbound Payment — response body — returned details value code, transaction
`returned_details (anyOf 2)`	null	Alternative
`statement_descriptor`	string	Required within parent	Information about the OutboundTransfer to be sent to the recipient account. Maximum length: 5000
`status`	string	Required within parent	Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. Known values: canceled, failed, posted, processing, returned
`status_transitions`	Model	Required within parent	Expand Cancel an Outbound Transfer — response body — status transitions
`tracking_details`	JSON	Optional
`tracking_details (anyOf 1)`	JSON	Alternative	Details about network-specific tracking information if available.
`tracking_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire
`tracking_details (anyOf 2)`	null	Alternative
`transaction`	JSON	Required within parent	The Transaction associated with this object.
`transaction (anyOf 1)`	string	Alternative	Maximum length: 5000
`transaction (anyOf 2)`	Model	Alternative	Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Outbound Payment — response body — returned details value code, transaction, Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire, Cancel an Outbound Transfer — response body — status transitions

Cancel an Outbound Transfer — response body — destination payment method details

Field	Type	Presence	Description and constraints
`$`	object	Root
`billing_details`	Model	Required within parent	Expand Retrieve a Received Debit — response body — initiating payment method details billing details
`financial_account`	Model	Optional	Expand Cancel an Outbound Transfer — response body — destination payment method details financial account
`type`	string	Required within parent	The type of the payment method used in the OutboundTransfer. Known values: financial_account, us_bank_account
`us_bank_account`	Model	Optional	Expand Cancel an Outbound Transfer — response body — destination payment method details us bank account

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details financial account, Cancel an Outbound Transfer — response body — destination payment method details us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an Outbound Payment — response body — returned details value code, transaction

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	string	Required within parent	Reason for the return. Known values: account_closed, account_frozen, bank_account_restricted, bank_ownership_changed, declined, incorrect_account_holder_name, invalid_account_number, invalid_currency, no_account, other
`transaction`	JSON	Required within parent	The Transaction associated with this object.
`transaction (anyOf 1)`	string	Alternative	Maximum length: 5000
`transaction (anyOf 2)`	Model	Alternative	Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire

Field	Type	Presence	Description and constraints
`$`	object	Root
`ach`	Model	Optional	Expand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach
`type`	string	Required within parent	The US bank account network used to send funds. Known values: ach, us_domestic_wire
`us_domestic_wire`	Model	Optional	Expand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Referenced models: Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach, Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
`$`	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.posttreasuryoutboundtransfers. Catalog operation: PostTreasuryOutboundTransfers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page