payrix-api-sdk 1.0.0

data/lib/payrix/models/configuration_stage_name_enum.rb

@@ -0,0 +1,212 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # configurationStageName.
+  class ConfigurationStageNameEnum
+    CONFIGURATION_STAGE_NAME_ENUM = [
+      # Blank. Used for a stage with no name.
+      BLANK = 'blank'.freeze,
+
+      # Set card types accepted by the merchant.
+      ACCEPTEDCARDS = 'acceptedCards'.freeze,
+
+      # TODO: Write general description for ACK
+      ACK = 'ack'.freeze,
+
+      # First Data merchant SRS activation.
+      ACTIVATESRS = 'activateSrs'.freeze,
+
+      # TODO: Write general description for ALERT
+      ALERT = 'alert'.freeze,
+
+      # Update merchant card enablement for American Express.
+      AMEXUPDATE = 'amexUpdate'.freeze,
+
+      # TODO: Write general description for APPLEPAY
+      APPLEPAY = 'applepay'.freeze,
+
+      # Bank account balance request for decisions and verifications processes.
+      BALANCE = 'balance'.freeze,
+
+      # Send batch command to terminal.
+      BATCH = 'batch'.freeze,
+
+      # Chargeback. The standard name used for chargeback related stages.
+      CHARGEBACK = 'chargeback'.freeze,
+
+      # ChargebackList. The specific name to get chargeback reports.
+      CHARGEBACKLIST = 'chargebackList'.freeze,
+
+      # Disbursement confirmation report retrieval.
+      CONFIRMDISBURSEMENT = 'confirmDisbursement'.freeze,
+
+      # Update merchant contacts.
+      CONTACTUPDATE = 'contactUpdate'.freeze,
+
+      # Send merchant details for merchant boarding.
+      CREATEMERCHANT = 'createMerchant'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # Set card types accepted by the merchant.
+      DECRYPT = 'decrypt'.freeze,
+
+      # Set card types accepted by the merchant.
+      DEBIT = 'debit'.freeze,
+
+      # Set merchant Pin Debit enablement.
+      DEBITPINENABLE = 'debitPinEnable'.freeze,
+
+      # Set merchant Pinless Debit enablement.
+      DEBITPINLESSENABLE = 'debitPinlessEnable'.freeze,
+
+      # Retrieve merchant transaction processing url.
+      DISCOVERURL = 'discoverUrl'.freeze,
+
+      # Update merchant card enablement for Discover.
+      DISCOVERUPDATE = 'discoverUpdate'.freeze,
+
+      # Document. The standard name for chargeback related documentation such as
+      # uploading a document or updating a document.
+      DOCUMENT = 'document'.freeze,
+
+      # DocumentList. Used for receiving documents related to a chargeback.
+      DOCUMENTLIST = 'documentList'.freeze,
+
+      # TODO: Write general description for INTERCHANGE
+      INTERCHANGE = 'interchange'.freeze,
+
+      # TODO: Write general description for ENCRYPT
+      ENCRYPT = 'encrypt'.freeze,
+
+      # Entity. The standard name used when it comes to entity related stages
+      # such as retrieving an entity or updating.
+      ENTITY = 'entity'.freeze,
+
+      # Update merchant legal entity address.
+      ENTITYADDRESSUPDATE = 'entityAddressUpdate'.freeze,
+
+      # EntityRetrieval. Used when entity stage name is already being used in
+      # that crud configuration.
+      ENTITYRETRIEVAL = 'entityRetrieval'.freeze,
+
+      # EntityUpdate. Used when entity stage name is already being used in that
+      # crud configuration.
+      ENTITYUPDATE = 'entityUpdate'.freeze,
+
+      # This holds the parameter for updating express subaccount.
+      EXPRESSSUBACCOUNTUPDATE = 'expressSubAccountUpdate'.freeze,
+
+      # Return. Used for return stage name.
+      ENUM_RETURN = 'return'.freeze,
+
+      # FeeList. The specific name to get fees reports.
+      FEELIST = 'feeList'.freeze,
+
+      # TODO: Write general description for GOOGLEPAY
+      GOOGLEPAY = 'googlepay'.freeze,
+
+      # MemberCreate. Stage name used to indicate creating a merchant member.
+      MEMBERCREATE = 'memberCreate'.freeze,
+
+      # MemberDelete. Stage name used to indicate deleting a merchant member.
+      MEMBERDELETE = 'memberDelete'.freeze,
+
+      # Members. Stage name used for creating several members for the merchant.
+      MEMBERS = 'members'.freeze,
+
+      # Update merchant member.
+      MEMBERUPDATE = 'memberUpdate'.freeze,
+
+      # Merchant. The standard name used for merchant related stages such
+      # retrieving a merchant or updating a merchant.
+      MERCHANT = 'merchant'.freeze,
+
+      # This holds the parameter for creating merchants with card present
+      # options, this is specific for WF and WFSingle platform.
+      MERCHANTCARDPRESENT = 'merchantCardPresent'.freeze,
+
+      # This holds the parameter for creating merchants with card not present
+      # options, this is specific for WF and WFSingle platform.
+      MERCHANTCARDNOTPRESENT = 'merchantCardNotPresent'.freeze,
+
+      # Update merchant details.
+      MERCHANTUPDATE = 'merchantUpdate'.freeze,
+
+      # MerchantRetrieval. Used when merchant stage name is already being used
+      # in that crud configuration.
+      MERCHANTRETRIEVAL = 'merchantRetrieval'.freeze,
+
+      # Noc. Stage name used for notification of change for disbursement related
+      # integrations.
+      NOC = 'noc'.freeze,
+
+      # TODO: Write general description for NOCRETURNS
+      NOCRETURNS = 'nocReturns'.freeze,
+
+      # This holds the parameters for omni token enablement.
+      OMNITOKENENABLE = 'omniTokenEnable'.freeze,
+
+      # This holds the parameters for pass token enablement.
+      PASSTOKENENABLE = 'passTokenEnable'.freeze,
+
+      # Send payment details for Account Updater request.
+      PAYMENT = 'payment'.freeze,
+
+      # Retrieve Account Updater request echo confirmation.
+      PAYMENTCONFIRMATION = 'paymentConfirmation'.freeze,
+
+      # Retrieve Account Updater updates.
+      PAYMENTUPDATE = 'paymentUpdate'.freeze,
+
+      # Payout. Stage name used for payouts.
+      PAYOUT = 'payout'.freeze,
+
+      # Update merchant primary member.
+      PRIMARYMEMBERUPDATE = 'primaryMemberUpdate'.freeze,
+
+      # First Data merchant SRS registration.
+      REGISTERSRS = 'registerSrs'.freeze,
+
+      # TODO: Write general description for RETURNCREDIT
+      RETURNCREDIT = 'returnCredit'.freeze,
+
+      # TODO: Write general description for RETURNDEBIT
+      RETURNDEBIT = 'returnDebit'.freeze,
+
+      # TODO: Write general description for RETURNS
+      RETURNS = 'returns'.freeze,
+
+      # This holds the parameters for safer payment enablement.
+      SAFERPAYMENTENABLE = 'saferPaymentEnable'.freeze,
+
+      # Send terminal details for terminal boarding.
+      TERMINALCREATE = 'terminalCreate'.freeze,
+
+      # Retrieve list of terminals for a merchant.
+      TERMINALLIST = 'terminalList'.freeze,
+
+      # Retrieve list of supported terminals for a merchant.
+      TERMINALSSUPPORTED = 'terminalsSupported'.freeze,
+
+      # Txn. The standard name used for transaction related stages.
+      TXN = 'txn'.freeze,
+
+      # TxnList. The specific name to get transaction reports.
+      TXNLIST = 'txnList'.freeze,
+
+      # This hold the parameter for accessing the terminal VARSHEET retrieval
+      VARSHEET = 'varsheet'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIGURATION_STAGE_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/configuration_stage_output_enum.rb

@@ -0,0 +1,268 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # configurationStageOutput.
+  class ConfigurationStageOutputEnum
+    CONFIGURATION_STAGE_OUTPUT_ENUM = [
+      # APPLE_PAYMENTSESSION_REQUEST_JSON output file.
+      APPLEPAYMENTSESSIONREQUESTJSON = 'APPLE_PAYMENTSESSION_REQUEST_JSON'.freeze,
+
+      # APPLE_REGISTER_MERCHANT_REQUEST_JSON output file.
+      APPLEREGISTERMERCHANTREQUESTJSON = 'APPLE_REGISTER_MERCHANT_REQUEST_JSON'.freeze,
+
+      # APPLE_UNREGISTER_MERCHANT_REQUEST_JSON output file.
+      APPLEUNREGISTERMERCHANTREQUESTJSON = 'APPLE_UNREGISTER_MERCHANT_REQUEST_JSON'.freeze,
+
+      # EFT output file.
+      EFT = 'EFT'.freeze,
+
+      # ELAVON_BATCH_FLAT output file. Batch file upload format and structure
+      # for the Elavon processor.
+      ELAVONBATCHFLAT = 'ELAVON_BATCH_FLAT'.freeze,
+
+      # ELAVON_BATCH_READ_FLAT output file. Batch file download format and
+      # structure for the Elavon processor.
+      ELAVONBATCHREADFLAT = 'ELAVON_BATCH_READ_FLAT'.freeze,
+
+      # ELAVON_BOARD_JSON output file. Merchant boarding format and structure
+      # for the Elavon processor.
+      ELAVONBOARDJSON = 'ELAVON_BOARD_JSON'.freeze,
+
+      # ELAVON_REPORTS_CSV output file. Settlement report format and structure
+      # for the Elavon processor.
+      ELAVONREPORTSCSV = 'ELAVON_REPORTS_CSV'.freeze,
+
+      # ELAVON_TXN_XML output file. Transaction authorization processing format
+      # and structure for the Elavon processor.
+      ELAVONTXNXML = 'ELAVON_TXN_XML'.freeze,
+
+      # FEDACH_REPORT_FLAT output file. Fed ACH routing number file format and
+      # structure.
+      FEDACHREPORTFLAT = 'FEDACH_REPORT_FLAT'.freeze,
+
+      # FIRSTDATA_BATCH_FLAT output file. Batch file format and structure for
+      # the First Data processor.
+      FIRSTDATABATCHFLAT = 'FIRSTDATA_BATCH_FLAT'.freeze,
+
+      # FIRSTDATA_BATCH_READ_FLAT output file.
+      FIRSTDATABATCHREADFLAT = 'FIRSTDATA_BATCH_READ_FLAT'.freeze,
+
+      # FIRSTDATA_BOARD_JSON output file. Merchant boarding format and structure
+      # for the First Data processor.
+      FIRSTDATABOARDJSON = 'FIRSTDATA_BOARD_JSON'.freeze,
+
+      # FIRSTDATA_REPORTS_FLAT output file. Settlement report format and
+      # structure for the First Data processor.
+      FIRSTDATAREPORTSFLAT = 'FIRSTDATA_REPORTS_FLAT'.freeze,
+
+      # FIRSTDATA_SRS_XML output file. SRS registration and activation format
+      # and structure for the First Data Processor.
+      FIRSTDATASRSXML = 'FIRSTDATA_SRS_XML'.freeze,
+
+      # FIRSTDATA_TXN_XML output file. Transaction authorization processing
+      # format and structure for the First Data processor.
+      FIRSTDATATXNXML = 'FIRSTDATA_TXN_XML'.freeze,
+
+      # FIRSTDATA_SINGLE_BATCH_FLAT output file.
+      FIRSTDATASINGLEBATCHFLAT = 'FIRSTDATA_SINGLE_BATCH_FLAT'.freeze,
+
+      # FIRSTDATA_SINGLE_TXN_XML output file.
+      FIRSTDATASINGLETXNXML = 'FIRSTDATA_SINGLE_TXN_XML'.freeze,
+
+      # NACHA output file. Disbursement file format and structure for the NACHA
+      # funding platform.
+      NACHA = 'NACHA'.freeze,
+
+      # NEUTRINO_CSV output file. BIN (Bank Issuer Number) file download format
+      # and structure for the Neutrino API service.
+      NEUTRINOCSV = 'NEUTRINO_CSV'.freeze,
+
+      # NEUTRINO_FORM output file. BIN (Bank Issuer Number) file request format
+      # and structure for the Neutrino API service.
+      NEUTRINOFORM = 'NEUTRINO_FORM'.freeze,
+
+      # NEUTRINO_JSON output file. BIN (Bank Issuer Number) file format and
+      # structure for the Neutrino API service.
+      NEUTRINOJSON = 'NEUTRINO_JSON'.freeze,
+
+      # OFAC_XML output file. Entity and member watchlist file download for the
+      # OFAC SDN list.
+      OFACXML = 'OFAC_XML'.freeze,
+
+      # PAYRIX_CHARGEBACK_JSON output file.
+      PAYRIXCHARGEBACKJSON = 'PAYRIX_CHARGEBACK_JSON'.freeze,
+
+      # PAYRIX_DECISION_JSON output file. Risk decision integration format and
+      # structure for the Payrix integration service.
+      PAYRIXDECISIONJSON = 'PAYRIX_DECISION_JSON'.freeze,
+
+      # PAYRIX_ENCRYPTION_JSON output file.
+      PAYRIXENCRYPTIONJSON = 'PAYRIX_ENCRYPTION_JSON'.freeze,
+
+      # PAYRIX_GOOGLEPAY_DECRYPTION_JSON output file.
+      PAYRIXGOOGLEPAYDECRYPTIONJSON = 'PAYRIX_GOOGLEPAY_DECRYPTION_JSON'.freeze,
+
+      # PAYRIX_TXN_JSON output file. Terminal activation response format and
+      # structure for the Payrix terminal app.
+      PAYRIXTXNJSON = 'PAYRIX_TXN_JSON'.freeze,
+
+      # PUSHY_TXN_JSON output file. Terminal activation request format and
+      # structure for the Pushy app messaging service.
+      PUSHYTXNJSON = 'PUSHY_TXN_JSON'.freeze,
+
+      # SIFT_JSON output file. Risk decision integration format and structure
+      # for the SIFT transaction monitoring service.
+      SIFTJSON = 'SIFT_JSON'.freeze,
+
+      # SOCURE_ALLOY_JSON output file. Risk decision integration format and
+      # structure for the Alloy integrator to Socure.
+      SOCUREALLOYJSON = 'SOCURE_ALLOY_JSON'.freeze,
+
+      # SOCURE_FORM output file. Risk decision integration request format and
+      # structure for the Socure member underwriting service.
+      SOCUREFORM = 'SOCURE_FORM'.freeze,
+
+      # SOCURE_JSON output file. Risk decision integration response format and
+      # structure for the Socure member underwriting service.
+      SOCUREJSON = 'SOCURE_JSON'.freeze,
+
+      # SOUNDPAYMENTS_TXN_FORM output file. Terminal activation request format
+      # and structure for the Sound Payments cloud activation service.
+      SOUNDPAYMENTSTXNFORM = 'SOUNDPAYMENTS_TXN_FORM'.freeze,
+
+      # SOUNDPAYMENTS_TXN_XML output file. Terminal activation response format
+      # and structure for the Sound Payments cloud activation service.
+      SOUNDPAYMENTSTXNXML = 'SOUNDPAYMENTS_TXN_XML'.freeze,
+
+      # VANTIV_BATCH_XML output file. Batch file format and structure for the
+      # WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVBATCHXML = 'VANTIV_BATCH_XML'.freeze,
+
+      # VANTIV_BOARD_XML output file. Merchant boarding format and structure for
+      # the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVBOARDXML = 'VANTIV_BOARD_XML'.freeze,
+
+      # VANTIV_CHARGEBACK_XML output file. Chargeback API format and structure
+      # for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVCHARGEBACKXML = 'VANTIV_CHARGEBACK_XML'.freeze,
+
+      # VANTIV_PAYMENT_UPDATES_XML output file. Account Updater format and
+      # structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP)
+      # processor.
+      VANTIVPAYMENTUPDATESXML = 'VANTIV_PAYMENT_UPDATES_XML'.freeze,
+
+      # VANTIV_PAYOUT_CSV output file. Payout reports format and structure for
+      # the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVPAYOUTCSV = 'VANTIV_PAYOUT_CSV'.freeze,
+
+      # VANTIV_PAYOUT_XML output file. Disbursement file format and structure
+      # for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVPAYOUTXML = 'VANTIV_PAYOUT_XML'.freeze,
+
+      # VANTIV_PAYOUT_XML_V9 output file. Old version 9 disbursement file format
+      # and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP)
+      # processor.
+      VANTIVPAYOUTXMLV9 = 'VANTIV_PAYOUT_XML_V9'.freeze,
+
+      # VANTIV_REPORTS_CSV output file. Settlement report format and structure
+      # for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVREPORTSCSV = 'VANTIV_REPORTS_CSV'.freeze,
+
+      # VANTIV_TXN_CSV output file. Echeck reports format and structure for the
+      # WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIVTXNCSV = 'VANTIV_TXN_CSV'.freeze,
+
+      # VANTIV_TXN_XML output file. Transaction authorization processing format
+      # and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP)
+      # processor.
+      VANTIVTXNXML = 'VANTIV_TXN_XML'.freeze,
+
+      # VCORE_BATCH_FLAT output file. Batch file upload format and structure for
+      # the WorldPay (aka Vantiv) Core processor.
+      VCOREBATCHFLAT = 'VCORE_BATCH_FLAT'.freeze,
+
+      # VCORE_BATCH_READ_FLAT output file. Batch file download format and
+      # structure for the WorldPay (aka Vantiv) Core processor.
+      VCOREBATCHREADFLAT = 'VCORE_BATCH_READ_FLAT'.freeze,
+
+      # VCORE_BINREPORT_FLAT output file. BIN (Bank Issuer Number) file download
+      # format and structure for the WorldPay (aka Vantiv) Core processor.
+      VCOREBINREPORTFLAT = 'VCORE_BINREPORT_FLAT'.freeze,
+
+      # VCORE_BOARD_API output file. New merchant boarding API format and
+      # structure for the WorldPay (aka Vantiv) Core processor.
+      VCOREBOARDAPI = 'VCORE_BOARD_API'.freeze,
+
+      # VCORE_BOARD_FLAT output file. Old merchant boarding creation file format
+      # and structure for the WorldPay (aka Vantiv) Core processor.
+      VCOREBOARDFLAT = 'VCORE_BOARD_FLAT'.freeze,
+
+      # VCORE_CHARGEBACK_FLAT output file. Chargeback file format and structure
+      # for the WorldPay (aka Vantiv) Core processor.
+      VCORECHARGEBACKFLAT = 'VCORE_CHARGEBACK_FLAT'.freeze,
+
+      # VCORE_OMNITOKEN_JSON output file.
+      VCOREOMNITOKENJSON = 'VCORE_OMNITOKEN_JSON'.freeze,
+
+      # VCORE_REPORTS_FLAT output file. Settlement report format and structure
+      # for the WorldPay (aka Vantiv) Core processor.
+      VCOREREPORTSFLAT = 'VCORE_REPORTS_FLAT'.freeze,
+
+      # VCORE_SAFERPAYMENT_JSON output file.
+      VCORESAFERPAYMENTJSON = 'VCORE_SAFERPAYMENT_JSON'.freeze,
+
+      # VCORE_TXN_ISO8583 output file. Transaction authorization processing for
+      # the WorldPay (aka Vantiv) Core processor.
+      VCORETXNISO8583 = 'VCORE_TXN_ISO8583'.freeze,
+
+      # VCORE_UPDATE_FLAT output file. Old merchant boarding update file format
+      # and structure for the WorldPay (aka Vantiv) Core processor.
+      VCOREUPDATEFLAT = 'VCORE_UPDATE_FLAT'.freeze,
+
+      # VCORE_VARSHEET_JSON output file.
+      VCOREVARSHEETJSON = 'VCORE_VARSHEET_JSON'.freeze,
+
+      # WEBSHIELD_FORM output file. Risk decision integration request format and
+      # structure for the Webshield entity underwriting service.
+      WEBSHIELDFORM = 'WEBSHIELD_FORM'.freeze,
+
+      # WEBSHIELD_JSON output file. Risk decision integration response format
+      # and structure for the Webshield entity underwriting service.
+      WEBSHIELDJSON = 'WEBSHIELD_JSON'.freeze,
+
+      # WELLSACH_BATCH_FLAT output file.
+      WELLSACHBATCHFLAT = 'WELLSACH_BATCH_FLAT'.freeze,
+
+      # WELLSACH_PAYOUT_FLAT output file.
+      WELLSACHPAYOUTFLAT = 'WELLSACH_PAYOUT_FLAT'.freeze,
+
+      # WELLSACH_TXN_FLAT output file.
+      WELLSACHTXNFLAT = 'WELLSACH_TXN_FLAT'.freeze,
+
+      # WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure
+      # for the Wells Fargo Merchant Services processor.
+      WELLSFARGOBOARDXML = 'WELLSFARGO_BOARD_XML'.freeze,
+
+      # WELLSFARGO_REPORT_CSV output file.
+      WELLSFARGOREPORTCSV = 'WELLSFARGO_REPORT_CSV'.freeze,
+
+      # WELLSFARGO_REPORT_FLAT output file.
+      WELLSFARGOREPORTFLAT = 'WELLSFARGO_REPORT_FLAT'.freeze,
+
+      # WFSINGLE_REPORT_FLAT output file.
+      WFSINGLEREPORTFLAT = 'WFSINGLE_REPORT_FLAT'.freeze,
+
+      # WFSINGLE_BOARD_XML output file.
+      WFSINGLEBOARDXML = 'WFSINGLE_BOARD_XML'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIGURATION_STAGE_OUTPUT_ENUM.include?(value)
+    end
+  end
+end