iyzico v1.0.1 Iyzico.Payment

Represents a successfully made payment returned from the platform.

Link to this section Summary

Functions

Converts a card association string into existing atom

Converts given card family string to existing atom

Converts a card type string into existing atom

Converts a given integer representation of a fraud status of a payment to respective type

Link to this section Types

Link to this type card_assoc()
card_assoc() :: :mastercard | :visa | :amex | :troy
Link to this type card_family()
card_family ::
  :bonus |
  :axess |
  :world |
  :maximum |
  :paraf |
  :cardfinans |
  :advantage
Link to this type card_type()
card_type() :: :credit | :debit | :prepaid
Link to this type currency()
currency() :: :try
Link to this type fraud_status()
fraud_status() :: :restrict | :awaiting | :ok
Link to this type t()
t() :: %Iyzico.Payment{basket_id: binary, bin_id: binary, card_assoc: card_assoc, card_family: card_family, card_type: card_type, commission_amount: number, commission_fee: number, conversation_id: binary, currency: currency, fraud_status: fraud_status, id: binary, installment: integer, last_four_digits: binary, merchant_commission_amount: number, merchant_commission_rate: number, paid_price: number, price: number, transactions: list}

Link to this section Functions

Link to this function get_card_assoc(assoc)
get_card_assoc(String.t) :: card_assoc

Converts a card association string into existing atom.

Examples

iex> Iyzico.Payment.get_card_assoc "MASTER_CARD"
:mastercard

iex> Iyzico.Payment.get_card_assoc "VISA"
:visa

iex> Iyzico.Payment.get_card_assoc "AMERICAN_EXPRESS"
:amex

iex> Iyzico.Payment.get_card_assoc "TROY"
:troy
Link to this function get_card_family(family)
get_card_family(String.t) :: card_family

Converts given card family string to existing atom.

Examples

iex> Iyzico.Payment.get_card_family "Bonus"
:bonus

iex> Iyzico.Payment.get_card_family "Axess"
:axess

iex> Iyzico.Payment.get_card_family "World"
:world

iex> Iyzico.Payment.get_card_family "Maximum"
:maximum

iex> Iyzico.Payment.get_card_family "Paraf"
:paraf

iex> Iyzico.Payment.get_card_family "CardFinans"
:cardfinans

iex> Iyzico.Payment.get_card_family "Advantage"
:advantage
Link to this function get_card_type(type)
get_card_type(String.t) :: card_type

Converts a card type string into existing atom.

Examples

iex> Iyzico.Payment.get_card_type "CREDIT_CARD"
:credit

iex> Iyzico.Payment.get_card_type "DEBIT_CARD"
:debit

iex> Iyzico.Payment.get_card_type "PREPAID_CARD"
:prepaid
Link to this function to_fraud_status(status)
to_fraud_status(integer) :: fraud_status

Converts a given integer representation of a fraud status of a payment to respective type.

Discussion

A merchant should only proceed to the transaction if and only if the fraud status is :ok. A payments fraud status would be :awaiting if transaction safety is being processed in present. Transactions with fraud status with :restrict value should be avoided.

Examples

iex> Iyzico.Payment.to_fraud_status -1
:restrict

iex> Iyzico.Payment.to_fraud_status 0
:awaiting

iex> Iyzico.Payment.to_fraud_status 1
:ok