payment.rb

# frozen_string_literal: true

module Minfraud
  module Components
    # Payment corresponds to the payment object of a minFraud request.
    #
    # @see https://dev.maxmind.com/minfraud/api-documentation/requests/?lang=en#schema--request--payment
    class Payment < Base
      include ::Minfraud::Enum
      include Minfraud::Validates

      # The payment method associated with the transaction. This must be one of
      # +:bank_debit+, +:bank_redirect+, +:bank_transfer+, +:buy_now_pay_later+,
      # +:card+, +:crypto+, +:digital_wallet+, +:gift_card+,
      # +:real_time_payment+, or +:rewards+.
      #
      # @!attribute method
      #
      # @return [Symbol, nil]
      enum_accessor :method,
                    %i[
                      bank_debit
                      bank_redirect
                      bank_transfer
                      buy_now_pay_later
                      card
                      crypto
                      digital_wallet
                      gift_card
                      real_time_payment
                      rewards
                    ]

      # The payment processor used for the transaction. The value is one
      # listed as a valid value, as a symbol.
      #
      # @!attribute processor
      #
      # @return [Symbol, nil]
      enum_accessor :processor, %i[
        adyen
        affirm
        afterpay
        altapay
        amazon_payments
        american_express_payment_gateway
        apple_pay
        aps_payments
        authorizenet
        balanced
        banquest
        beanstream
        bluepay
        bluesnap
        boacompra
        boku
        bpoint
        braintree
        cardknox
        cardpay
        cashfree
        ccavenue
        ccnow
        cetelem
        chase_paymentech
        checkout_com
        cielo
        collector
        commdoo
        compropago
        concept_payments
        conekta
        coregateway
        creditguard
        credorax
        cryptomus
        ct_payments
        cuentadigital
        curopayments
        cybersource
        dalenys
        dalpay
        datacap
        datacash
        dibs
        digital_river
        dlocal
        dotpay
        ebs
        ecomm365
        ecommpay
        elavon
        emerchantpay
        epay
        epayco
        eprocessing_network
        epx
        eway
        exact
        fat_zebra
        first_atlantic_commerce
        first_data
        fiserv
        g2a_pay
        global_payments
        gocardless
        google_pay
        heartland
        hipay
        ingenico
        interac
        internetsecure
        intuit_quickbooks_payments
        iugu
        klarna
        komoju
        lemon_way
        mastercard_payment_gateway
        mercadopago
        mercanet
        merchant_esolutions
        mirjeh
        mollie
        moneris_solutions
        neopay
        neosurf
        nmi
        oceanpayment
        oney
        onpay
        openbucks
        openpaymx
        optimal_payments
        orangepay
        other
        pacnet_services
        payconex
        payeezy
        payfast
        paygate
        paylike
        payment_express
        paymentwall
        payone
        paypal
        payplus
        paysafecard
        paysera
        paystation
        paytm
        paytrace
        paytrail
        payture
        payu
        payulatam
        payvision
        payway
        payza
        pinpayments
        placetopay
        posconnect
        princeton_payment_solutions
        psigate
        pxp_financial
        qiwi
        quickpay
        raberil
        razorpay
        rede
        redpagos
        rewardspay
        safecharge
        sagepay
        securepay
        securetrading
        shopify_payments
        simplify_commerce
        skrill
        smartcoin
        smartdebit
        solidtrust_pay
        sps_decidir
        stripe
        summit_payments
        synapsefi
        systempay
        telerecargas
        towah
        transact_pro
        trustly
        trustpay
        tsys
        usa_epay
        vantiv
        verepay
        vericheck
        vindicia
        virtual_card_services
        vme
        vpos
        windcave
        wirecard
        worldpay
        yaadpay
      ]

      # The authorization outcome from the payment processor. If the
      # transaction has not yet been approved or denied, do not include this
      # field.
      #
      # @return [Boolean, nil]
      attr_accessor :was_authorized

      # The decline code as provided by your payment processor. If the
      # transaction was not declined, do not include this field.
      #
      # @return [String, nil]
      attr_accessor :decline_code

      # @param params [Hash] Hash of parameters. Each key/value should
      #   correspond to one of the available attributes.
      def initialize(params = {})
        @was_authorized = params[:was_authorized]
        @decline_code   = params[:decline_code]
        self.method     = params[:method]
        self.processor  = params[:processor]

        validate
      end

      private

      def validate
        return if !Minfraud.enable_validation

        validate_boolean('was_authorized', @was_authorized)
        validate_string('decline_code', 255, @decline_code)
      end
    end
  end
end