Stripe.Services.TestHelpers.Treasury.OutboundPaymentService (tiger_stripe v0.1.10)

Copy Markdown View Source

OutboundPayment API operations.

Summary

Functions

Test mode: Fail an OutboundPayment

Test mode: Post an OutboundPayment

Test mode: Update an OutboundPayment

Functions

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

@spec fail(Stripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, Stripe.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(Stripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, Stripe.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(Stripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, Stripe.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(Stripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, Stripe.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.