Create an OutboundTransfer
POST / v1 / treasury / outbound_transfers
Creates an OutboundTransfer.
Parameters
- amount integer Required Amount (in cents) to be transferred.
- currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial _ account string Required The FinancialAccount to pull funds from.
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- destination _ payment _ method string The PaymentMethod to use as the payment instrument for the OutboundTransfer.
- destination _ payment _ method _ data object Preview feature Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with
destination_payment_method. - destination _ payment _ method _ options object Hash describing payment method configuration details.
- metadata map 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 _ descriptor string Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for
achtransfers or 140 characters forus_domestic_wiretransfers. The default value is “transfer”. Can only include -#.amp;*, spaces, and alphanumeric characters.
Returns
Returns an OutboundTransfer object if there were no issues with OutboundTransfer creation. The status of the created OutboundTransfer object is initially marked as processing.
Response
Retrieve an OutboundTransfer
GET / v1 / treasury / outbound_transfers /:id
Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
Parameters
No parameters.
Returns
Returns an OutboundTransfer object if a valid identifier was provided. Otherwise, returns an error.
Response
List all OutboundTransfers
GET / v1 / treasury / outbound_transfers
Returns a list of OutboundTransfers sent from the specified FinancialAccount.
Parameters
- financial _ account string Returns objects associated with this FinancialAccount.
- status enum Only return OutboundTransfers that have the given status:
processing,canceled,failed,posted, orreturned.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit OutboundTransfers, starting after OutboundTransfer starting_after. Each entry in the array is a separate OutboundTransfer object. If no more OutboundTransfers are available, the resulting array is empty.
Response