Increase.Simulations.CardDisputes (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Card Dispute.

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

After a Card Dispute is created in production, the dispute will initially be in a pending_user_submission_reviewing state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.

Functions

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

@spec action(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.CardDisputes.CardDispute.t()} | {:error, Increase.Error.t()}

After a Card Dispute is created in production, the dispute will initially be in a pending_user_submission_reviewing state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.

POST /simulations/card_disputes/{card_dispute_id}/action