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
Cancel an InboundTransfer
POST / v1 / treasury / inbound_transfers /:id / cancel
Cancels an InboundTransfer.
Parameters
No parameters.
Returns
Returns the InboundTransfer object if the cancellation succeeded. Returns an error if the InboundTransfer has already been canceled or cannot be canceled.
Response
Test mode: Fail an InboundTransfer Test helper
POST / v1 / test_helpers / treasury / inbound_transfers /:id / fail
Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
Parameters
- failure _ details object Details about a failed InboundTransfer.
Returns
Returns the InboundTransfer object in the returned state. Returns an error if the InboundTransfer has already failed or cannot be failed.
Response