Increase.Simulations.CardAuthentications (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Card Authentication.

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

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

Simulates an attempt at a Card Authentication Challenge. This updates the card_authentications object under the Card Payment. You can also attempt the challenge by navigating to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.

challenges(client, card_payment_id, opts \\ [])

Simulates starting a Card Authentication Challenge for an existing Card Authentication. This updates the card_authentications object under the Card Payment. To attempt the challenge, use the /simulations/card_authentications/:card_payment_id/challenge_attempts endpoint or navigate to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.

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

Simulates a Card Authentication attempt on a Card. The attempt always results in a Card Payment being created, either with a status that allows further action or a terminal failed status.

Functions

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

@spec challenge_attempts(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) :: {:ok, Increase.CardPayments.CardPayment.t()} | {:error, Increase.Error.t()}

Simulates an attempt at a Card Authentication Challenge. This updates the card_authentications object under the Card Payment. You can also attempt the challenge by navigating to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.

POST /simulations/card_authentications/{card_payment_id}/challenge_attempts

challenges(client, card_payment_id, opts \\ [])

@spec challenges(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardPayments.CardPayment.t()} | {:error, Increase.Error.t()}

Simulates starting a Card Authentication Challenge for an existing Card Authentication. This updates the card_authentications object under the Card Payment. To attempt the challenge, use the /simulations/card_authentications/:card_payment_id/challenge_attempts endpoint or navigate to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.

POST /simulations/card_authentications/{card_payment_id}/challenges

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

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

Simulates a Card Authentication attempt on a Card. The attempt always results in a Card Payment being created, either with a status that allows further action or a terminal failed status.

POST /simulations/card_authentications