Search documentation of tiger_stripe

# Stripe.Services.Treasury.OutboundTransferService (tiger_stripe v0.1.1)

Copy Markdown View Source

TreasuryOutboundTransfersResourceOutboundTransfer

Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.

Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundTransfer objects

## Summary

### Functions

cancel(client, outbound_transfer, params \\ %{}, opts \\ [])

Cancel an OutboundTransfer

create(client, params \\ %{}, opts \\ [])

Create an OutboundTransfer

list(client, params \\ %{}, opts \\ [])

List all OutboundTransfers

retrieve(client, outbound_transfer, params \\ %{}, opts \\ [])

Retrieve an OutboundTransfer

## Functions

# cancel(client, outbound_transfer, params \\ %{}, opts \\ [])

    @spec cancel(Stripe.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Cancel an OutboundTransfer

An OutboundTransfer can be canceled if the funds have not yet been paid out.

# create(client, params \\ %{}, opts \\ [])

    @spec create(Stripe.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Create an OutboundTransfer

Creates an OutboundTransfer.

# list(client, params \\ %{}, opts \\ [])

    @spec list(Stripe.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

List all OutboundTransfers

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

# retrieve(client, outbound_transfer, params \\ %{}, opts \\ [])

    @spec retrieve(Stripe.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, Stripe.Error.t()}

Retrieve an OutboundTransfer

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.