Create an InboundTransfer
POST / v1 / treasury / inbound_transfers
Creates an InboundTransfer.
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 send funds to.
- origin _ payment _ method string Required The origin payment method to be debited for the InboundTransfer.
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- 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 The complete description that appears on your customers’ statements. Maximum 10 characters. Can only include -#.amp;*, spaces, and alphanumeric characters.
Returns
Returns an InboundTransfer object if there were no issues with InboundTransfer creation. The status of the created InboundTransfer object is initially marked as processing.
Response
Retrieve an InboundTransfer
GET / v1 / treasury / inbound_transfers /:id
Retrieves the details of an existing InboundTransfer.
Parameters
No parameters.
Returns
Returns an InboundTransfer object if a valid identifier was provided. Otherwise, returns an error.
Response
List all InboundTransfers
GET / v1 / treasury / inbound_transfers
Returns a list of InboundTransfers sent from the specified FinancialAccount.
Parameters
- financial _ account string Returns objects associated with this FinancialAccount.
- status enum Only return InboundTransfers that have the given status:
processing,succeeded,failedorcanceled.
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 InboundTransfers, starting after InboundTransfer starting_after. Each entry in the array is a separate InboundTransfer object. If no more InboundTransfers are available, the resulting array is empty.
Response