StripeElixir.Services.Treasury.InboundTransferService (stripe_elixir v0.1.0)

Copy Markdown View Source

TreasuryInboundTransfersResourceInboundTransfer

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Related guide: Moving money with Treasury using InboundTransfer objects

Summary

Functions

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

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

Cancel an InboundTransfer

Cancels an InboundTransfer.

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

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

Create an InboundTransfer

Creates an InboundTransfer.

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

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

List all InboundTransfers

Returns a list of InboundTransfers 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 InboundTransfer

Retrieves the details of an existing InboundTransfer.