Search documentation of tiger_stripe

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

Copy Markdown View Source

OutboundTransfer API operations.

## Summary

### Functions

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

Test mode: Fail an OutboundTransfer

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

Test mode: Post an OutboundTransfer

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

Test mode: Return an OutboundTransfer

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

Test mode: Update an OutboundTransfer

## Functions

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

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

Test mode: Fail an OutboundTransfer

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

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

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

Test mode: Post an OutboundTransfer

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

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

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

Test mode: Return an OutboundTransfer

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

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

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

Test mode: Update an OutboundTransfer

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