provider POST /v1/treasury/outbound_transfers
@utdk/stripe /v1/treasury/outbound_transfers
Create an OutboundTransfer
<p>Creates an OutboundTransfer.</p>

Try it

Authentication
Configure credentials for Stripe API
posttreasuryoutboundtransfers
POST/v1/treasury/outbound_transfers
<p>Creates an OutboundTransfer.</p>

Input

required

Amount (in cents) to be transferred.

required

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).

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

The PaymentMethod to use as the payment instrument for the OutboundTransfer.

Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.

Hash describing payment method configuration details.

Specifies which fields in the response should be expanded.

required

The FinancialAccount to pull funds from.

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`.

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.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.posttreasuryoutboundtransfers()