StripeElixir.Services.TestHelpers.Treasury.OutboundPaymentService
(stripe_elixir v0.1.0)
Copy Markdown
View Source
OutboundPayment API operations.
Summary
Functions
Test mode: Fail an OutboundPayment
Test mode: Post an OutboundPayment
Test mode: Return an OutboundPayment
Test mode: Update an OutboundPayment
Functions
@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.
@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.
@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.
@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.