Increase.Simulations.CardRefunds (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Card Refund.

These endpoints only work against the sandbox environment and let you fast-forward events that would otherwise take hours or days in production (settlement, acknowledgement, returns, and so on). See https://increase.com/documentation/api/overview#sandbox for details.

Summary

Functions

Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.

Functions

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Transactions.Transaction.t()} | {:error, Increase.Error.t()}

Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.

POST /simulations/card_refunds