Synctera.CardTransactionSimulations (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Card Transaction Simulations' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Simulate authorization — Simulate an authorization type transaction by including the card_token and other authorization details in your request.

Like simulate_authorization/2 but returns the value directly and raises on error.

Simulate authorization advice — An authorization advice allows an amount to be decreased after the authorization. This endpoint allows you to simulate post-swipe adjustments. Simulate an authorization.advice type transaction by including the original_transaction_token and other authorization details in your request.

Like simulate_authorization_advice/2 but returns the value directly and raises on error.

Simulate balance inquiry — Simulate a pindebit.balanceinquiry type transaction by sending a POST request to the /simulate/financial/balanceinquiry endpoint.

Like simulate_balance_inquiry/2 but returns the value directly and raises on error.

Simulate clearing or refund — Simulate an authorization.clearing type transaction by including the original_transaction_token and amount in your request. To simulate a refund type transaction, set the is_refund field to true.

Like simulate_clearing/2 but returns the value directly and raises on error.

Simulate financial — A "financial" is a transaction message class that includes ATM transactions, PIN-debit transactions, and balance inquiries. Simulate a pindebit type transaction by including the card_token and amount in your request.

Like simulate_financial/2 but returns the value directly and raises on error.

Simulate financial advice — Simulate a financial advice by including the original_transaction_token and other authorization details in JSON format in the body of the request.

Like simulate_financial_advice/2 but returns the value directly and raises on error.

Simulate OCT — This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not linked to any purchase. Simulate an OCT by including the card_token, amount, mid, and type in your request.

Like simulate_original_credit/2 but returns the value directly and raises on error.

Simulate reversal — A reversal releases the hold that was placed on account funds by an authorization, thus returning the funds to the account. Simulate an authorization.reversal type transaction by including the original_transaction_token and amount in your request.

Like simulate_reversal/2 but returns the value directly and raises on error.

Simulate ATM withdrawal — Simulate a pindebit.atm.withdrawal type transaction by including the card_token and amount in your request.

Like simulate_withdrawal/2 but returns the value directly and raises on error.

Functions

simulate_authorization(client, opts \\ [])

@spec simulate_authorization(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate authorization — Simulate an authorization type transaction by including the card_token and other authorization details in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_authorization!(client, opts)

@spec simulate_authorization!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_authorization/2 but returns the value directly and raises on error.

simulate_authorization_advice(client, opts \\ [])

@spec simulate_authorization_advice(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate authorization advice — An authorization advice allows an amount to be decreased after the authorization. This endpoint allows you to simulate post-swipe adjustments. Simulate an authorization.advice type transaction by including the original_transaction_token and other authorization details in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_authorization_advice!(client, opts)

@spec simulate_authorization_advice!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_authorization_advice/2 but returns the value directly and raises on error.

simulate_balance_inquiry(client, opts \\ [])

@spec simulate_balance_inquiry(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate balance inquiry — Simulate a pindebit.balanceinquiry type transaction by sending a POST request to the /simulate/financial/balanceinquiry endpoint.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_balance_inquiry!(client, opts)

@spec simulate_balance_inquiry!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_balance_inquiry/2 but returns the value directly and raises on error.

simulate_clearing(client, opts \\ [])

@spec simulate_clearing(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate clearing or refund — Simulate an authorization.clearing type transaction by including the original_transaction_token and amount in your request. To simulate a refund type transaction, set the is_refund field to true.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_clearing!(client, opts)

@spec simulate_clearing!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_clearing/2 but returns the value directly and raises on error.

simulate_financial(client, opts \\ [])

@spec simulate_financial(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate financial — A "financial" is a transaction message class that includes ATM transactions, PIN-debit transactions, and balance inquiries. Simulate a pindebit type transaction by including the card_token and amount in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_financial!(client, opts)

@spec simulate_financial!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_financial/2 but returns the value directly and raises on error.

simulate_financial_advice(client, opts \\ [])

@spec simulate_financial_advice(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate financial advice — Simulate a financial advice by including the original_transaction_token and other authorization details in JSON format in the body of the request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_financial_advice!(client, opts)

@spec simulate_financial_advice!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_financial_advice/2 but returns the value directly and raises on error.

simulate_original_credit(client, opts \\ [])

@spec simulate_original_credit(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate OCT — This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not linked to any purchase. Simulate an OCT by including the card_token, amount, mid, and type in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_original_credit!(client, opts)

@spec simulate_original_credit!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_original_credit/2 but returns the value directly and raises on error.

simulate_reversal(client, opts \\ [])

@spec simulate_reversal(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate reversal — A reversal releases the hold that was placed on account funds by an authorization, thus returning the funds to the account. Simulate an authorization.reversal type transaction by including the original_transaction_token and amount in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_reversal!(client, opts)

@spec simulate_reversal!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_reversal/2 but returns the value directly and raises on error.

simulate_withdrawal(client, opts \\ [])

@spec simulate_withdrawal(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Simulate ATM withdrawal — Simulate a pindebit.atm.withdrawal type transaction by including the card_token and amount in your request.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

simulate_withdrawal!(client, opts)

@spec simulate_withdrawal!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like simulate_withdrawal/2 but returns the value directly and raises on error.