Search documentation of stripe_elixir

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

Copy Markdown View Source

OutboundPayment API operations.

## Summary

### Functions

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

Test mode: Fail an OutboundPayment

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

Test mode: Post an OutboundPayment

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

Test mode: Return an OutboundPayment

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

Test mode: Update an OutboundPayment

## Functions

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

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

Test mode: Fail an OutboundPayment

Transitions a test mode created OutboundPayment to the `failed` status. The OutboundPayment must already be in the `processing` state.

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

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

Test mode: Post an OutboundPayment

Transitions a test mode created OutboundPayment to the `posted` status. The OutboundPayment must already be in the `processing` state.

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

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

Test mode: Return an OutboundPayment

Transitions a test mode created OutboundPayment to the `returned` status. The OutboundPayment must already be in the `processing` state.

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

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

Test mode: Update an OutboundPayment

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the `canceled` or `failed` states.