Siftsciex

v0.5.0

Siftsciex v0.5.0 Siftsciex.Event.Payload.PaymentMethod View Source

This module will construct and return a payment method struct of the specified type.

Link to this section Summary

Types

attribute()
data()
source()
t()

Functions

new(methods)

Creates a new Payment Method object for Sift Science

Link to this section Types

Link to this type attribute() View Source 
attribute() ::
  :payment_gateway
  | :card_bin
  | :card_last4
  | :avs_result_code
  | :cvv_result_code
  | :verification_status
  | :routing_number
  | :decline_reason_code
  | :paypal_payer_id
  | :paypal_payer_email
  | :paypal_payer_status
  | :paypal_address_status
  | :paypal_protection_eligibility
  | :paypal_payment_status
  | :stripe_cvc_check
  | :stripe_address_line1_check
  | :stripe_address_line2_check
  | :stripe_address_zip_check
  | :stripe_funding
  | :stripe_brand
Link to this type data() View Source 
data() :: %{:payment_type => source(), optional(attribute()) => String.t()}
Link to this type source() View Source 
source() ::
  :cash
  | :check
  | :credit_card
  | :crypto_currency
  | :digital_wallet
  | :electronic_fund_transfer
  | :financing
  | :gift_card
  | :invoice
  | :in_app_purchase
  | :money_order
  | :points
  | :store_credit
  | :third_party_processor
Link to this type t() View Source 
t() :: %Siftsciex.Event.Payload.PaymentMethod{
  "$avs_result_code": Siftsciex.Event.Payload.payload_string(),
  "$card_bin": Siftsciex.Event.Payload.payload_string(),
  "$card_last4": Siftsciex.Event.Payload.payload_string(),
  "$cvv_result_code": Siftsciex.Event.Payload.payload_string(),
  "$decline_reason_code": Siftsciex.Event.Payload.payload_string(),
  "$payment_gateway": Siftsciex.Event.Payload.payload_string(),
  "$payment_type": Siftsciex.Event.Payload.payload_string(),
  "$paypal_address_status": Siftsciex.Event.Payload.payload_string(),
  "$paypal_payer_email": Siftsciex.Event.Payload.payload_string(),
  "$paypal_payer_id": Siftsciex.Event.Payload.payload_string(),
  "$paypal_payer_status": Siftsciex.Event.Payload.payload_string(),
  "$paypal_payment_status": Siftsciex.Event.Payload.payload_string(),
  "$paypal_protection_eligibility": Siftsciex.Event.Payload.payload_string(),
  "$routing_number": Siftsciex.Event.Payload.payload_string(),
  "$stripe_address_line1_check": Siftsciex.Event.Payload.payload_string(),
  "$stripe_address_line2_check": Siftsciex.Event.Payload.payload_string(),
  "$stripe_address_zip_check": Siftsciex.Event.Payload.payload_string(),
  "$stripe_brand": Siftsciex.Event.Payload.payload_string(),
  "$stripe_cvc_check": Siftsciex.Event.Payload.payload_string(),
  "$stripe_funding": Siftsciex.Event.Payload.payload_string(),
  "$verification_status": Siftsciex.Event.Payload.payload_string()
}

Link to this section Functions

Link to this function new(methods) View Source 
new(data() | [data()]) ::
  Siftsciex.Event.Payload.PaymentMethod.t()
  | [Siftsciex.Event.Payload.PaymentMethod.t()]
  | :empty

Creates a new Payment Method object for Sift Science

Parameters

  • data: The general data about the payment method, multiple payment methods may be passed together, there are several available attributes.

    • :payment_gateway
    • :card_bin - The first 6 digits of the card number
    • :card_last4
    • :avs_result_code
    • :cvv_result_code
    • :verification_status
    • :routing_number
    • :decline_reason_code
    • :paypal_payer_id
    • :paypal_payer_email
    • :paypal_payer_status
    • :paypal_address_status
    • :paypal_protection_eligibility
    • :paypal_payment_status
    • :stripe_cvc_check
    • :stripe_address_line1_check
    • :stripe_address_line2_check
    • :stripe_address_zip_check
    • :stripe_funding
    • :stripe_brand

Examples 

iex> PaymentMethod.new(%{payment_type: :credit_card})
%PaymentMethod{"$payment_type": "$credit_card"}

iex> PaymentMethod.new(%{payment_type: :credit_card, payment_gateway: "stripe"})
%PaymentMethod{"$payment_type": "$credit_card", "$payment_gateway": "$stripe"}

iex> PaymentMethod.new([%{payment_type: :credit_card}, %{payment_type: :credit_card, payment_gateway: "stripe"}])
[%PaymentMethod{"$payment_type": "$credit_card"}, %PaymentMethod{"$payment_type": "$credit_card", "$payment_gateway": "$stripe"}]

iex> PaymentMethod.new(%{payment_type: :credit_card, payment_gateway: "bogus"})
:empty