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
Cancel an OutboundTransfer
POST / v1 / treasury / outbound_transfers /:id / cancel
An OutboundTransfer can be canceled if the funds have not yet been paid out.
Parameters
No parameters.
Returns
Returns the OutboundTransfer object if the cancellation succeeded. Returns an error if the object has already been canceled or cannot be canceled.
Response