Search documentation of stripe_elixir

# StripeElixir.Services.Treasury.OutboundPaymentService (stripe_elixir v0.1.0)

Copy Markdown View Source

TreasuryOutboundPaymentsResourceOutboundPayment

Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

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

Related guide: Moving money with Treasury using OutboundPayment objects

## Summary

### Functions

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

Cancel an OutboundPayment

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

Create an OutboundPayment

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

List all OutboundPayments

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

Retrieve an OutboundPayment

## Functions

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

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

Cancel an OutboundPayment

Cancel an OutboundPayment.

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

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

Create an OutboundPayment

Creates an OutboundPayment.

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

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

List all OutboundPayments

Returns a list of OutboundPayments sent from the specified FinancialAccount.

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

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

Retrieve an OutboundPayment

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