Create an OutboundTransfer

Changed on

Creates an OutboundTransfer.

post/v1/treasury/outbound_transfers

Request

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

Request body application/x-www-form-urlencoded

amountinteger required

Amount (in cents) to be transferred.

currencystring currency required

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

descriptionstring

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

destination_payment_methodstring

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

expandstring[]

Specifies which fields in the response should be expanded.

financial_accountstring required

The FinancialAccount to pull funds from.

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.

statement_descriptorstring

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.

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

cancelableboolean required

Returns true if the object can be canceled, and false otherwise.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

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.

destination_payment_methodstring nullable

The PaymentMethod used as the payment instrument for an OutboundTransfer.

expected_arrival_dateinteger required

The date when funds are expected to arrive in the destination account.

financial_accountstring required

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_urlstring nullable

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

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'treasury.outbound_transfer' required

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

statement_descriptorstring required

Information about the OutboundTransfer to be sent to the recipient account.

status'canceled' | 'failed' | 'posted' | 'processing' | 'returned' required

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.

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.