NexumAPI Docs
NexumAPI Docs
  • Introduction
  • Authentication
  • Quickstart
  • NaaS Endpoints
  • Capabilities
  • Changelog
  • Links
    • NexumAPI
    • GitHub
  • Resources
    • Symitar Playground
    • Help & Feedback
  • SymXchange
    • API Reference
      • Persistent
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InformationService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
      • v2022.01
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CashMachines
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • EpisysInformationService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParameterService
          • AccountDefault
          • AccountFieldName
          • AcctLimit
          • AcctMembGrpDesc
          • AcctRelCodeDesc
          • AcctTrackingType
          • AcctTypeName
          • AcsGlobal
          • AcsService
          • ActivityFm
          • AnalysisFloat
          • AnalysisGlobal
          • AnalysisPlan
          • ApPmtTermsTablePagedList
          • ApWorkFlow
          • Atm
          • Audio
          • BatchRc
          • CardDefault
          • CardWiz
          • CashOrderVendor
          • Cdm
          • CheckOrderDefault
          • CollateralType
          • CollatrlTrackingType
          • Comment
          • ConsoleFm
          • CorpTransfer
          • CpLetter
          • CpWorkCard
          • CreditReport
          • Crs
          • CurrencyCtrl
          • DailyPost
          • DealerStatement
          • DebtRatio
          • Disclosure
          • DivIndexGlobal
          • DivIndexLocal
          • DivTable
          • DocExcpNotice
          • DocTypeDefault
          • DocumentNumber
          • EpisysDbExtract
          • EscrowAnalysis
          • EscrowType
          • ExtLoan
          • GlCategory
          • GlCode
          • GlTable
          • GlTrackingType
          • GlxLate
          • IdentIdTypeDesc
          • Imaging
          • InqDefinition
          • InsTable
          • InsType
          • Institution
          • IntIndex
          • IntType
          • InventoryCopiedFlds
          • InventoryDefault
          • InventoryFieldName
          • InventoryType
          • IrsBkupWithhold
          • IrsContriLimit
          • ItcFraud
          • ItcInstallation
          • LateChg
          • LnSegmentDefault
          • LoanAppCopiedFlds
          • LoanAppDefault
          • LoanAppDenial
          • LoanAppFieldName
          • LoanAppFormPkt
          • LoanAppMisc
          • LoanAppPrintApp
          • LoanAppReusedFlds
          • LoanAppVerForm
          • LoanAppViewApp
          • LoanAppWorkFlow
          • LoanDefault
          • LoanFieldName
          • LoanTypeIdRange
          • LookupTypeName
          • Misc
          • MoProduct
          • NameFieldName
          • Ncua5300
          • NonRegCc
          • Notice
          • OnlineBlock
          • OnlineCard
          • OnlineFee
          • OnlineFile
          • OnlineMain
          • OnlineNet
          • OnlineOutlet
          • OnlineSbAddOn
          • OnlineSba
          • OnlineSbi
          • Param360View
          • Parameter
          • PartStatement
          • PartTrackingType
          • ParticipantFieldName
          • PayCalc
          • PeriodicMtg
          • PlanDefault
          • PlanFieldName
          • PmtAppMethod
          • PositivePay
          • PreferenceDefault
          • PrivGroup
          • RegCc
          • ScreenDefinition
          • SecField
          • Security
          • ShareDefault
          • ShareFieldName
          • Statement
          • StmtMailName
          • StmtMessages
          • Stock
          • SycClient
          • SycGeneral
          • SymXClient
          • SymXDeviceMap
          • SymXGeneral
          • SymXInstance
          • SynapsysMrm
          • TcProduct
          • TellerFee
          • TellerTranFee
          • TellerTranValidate
          • Tpt
          • TrackingCode
          • UserFm
          • UserTrackingFm
          • UserTrackingType
          • Warnings
          • WdFee
          • WestUnCommCode
          • WireBfc
          • WireCorpVer
          • WireIdCode
          • WireInCmtCode
          • WireMisc
          • WireOutCmtCode
          • WireTypeCode
          • WorkFlowRepGen
          • YellowHammer
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • SymXchangeVerificationService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
    • Credentials
    • Device Information
Powered by GitBook
On this page

Was this helpful?

  1. SymXchange
  2. API Reference
  3. v2022.01
  4. ParameterService

OnlineFile

PreviousOnlineFeeNextOnlineMain

Last updated 9 months ago

Was this helpful?

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetOnlineFile
  • POSTgetOnlineFileSelectFields
  • POSTgetOnlineFilePagedList
  • POSTgetOnlineFileListSelectFields
  • POSTsearchOnlineFileSelectFields
  • POSTgetOnlineFilePagedListSelectFields
  • POSTsearchOnlineFilePagedSelectFields
  • POSTgetOnlineFileMgr
  • POSTgetOnlineFileMgrSelectFields
  • POSTupdateOnlineFileByID
  • POSTupdateOnlineFileMgrByID

getOnlineFile

post

Retrieve online file information

Authorizations
Body
OnlineFileFileRecordintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFileFileRecord": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFile": {
    "AvailBalExclList": "text",
    "AvailBalInclOdProtection": true,
    "AvailBalInclOdTolerance": true,
    "CardType": 1,
    "ExcludedStatusReasonCodes": "text",
    "FileRecord": 1,
    "FileType": 1,
    "FileUpdateMethod": 1,
    "FraudControlTrackingType": 1,
    "FwdUpdateToPinNetwork": true,
    "FwdUpdatetoVisaMasterCard": true,
    "HighPriorityMsgOption": 1,
    "InstitutionId": "text",
    "LimitGroupId": "text",
    "MinimumBalanceChange": 1,
    "NetworkMessageFormat": 1,
    "PurgeDays": 1,
    "ReceiveCardFraudNoteCode": 1,
    "SendActivationMessage": true,
    "SendBalances": true,
    "SendCardFraudNoteCode": 1,
    "SendNewCardOption": 1,
    "SendPinOffsetMessage": true,
    "SuffixFormat": 1,
    "ThirdPartyPayments": [
      {
        "EntryId": 1,
        "ThirdPartyPayments": true
      }
    ],
    "UseMailOverride": true,
    "FwdUpdatesfrmOtherNetworks": "text",
    "VauAbuOptOutWarningCode": 1,
    "DigitalIssueTrackingType": 1,
    "BonusAwardsTrackingType": 1,
    "CardFraudNoteExpDays": 1
  }
}

getOnlineFileSelectFields

post

Retrieve online file select fields

Authorizations
Body
OnlineFileFileRecordintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFileSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1043

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFileFileRecord": 1,
  "SelectableFields": {
    "IncludeAllOnlineFileFields": true,
    "OnlineFileFields": {
      "AvailBalExclList": true,
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "BonusAwardsTrackingType": true,
      "CardFraudNoteExpDays": true,
      "CardType": true,
      "DigitalIssueTrackingType": true,
      "ExcludedStatusReasonCodes": true,
      "FileRecord": true,
      "FileType": true,
      "FileUpdateMethod": true,
      "FraudControlTrackingType": true,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatesfrmOtherNetworks": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": true,
      "InstitutionId": true,
      "LimitGroupId": true,
      "MinimumBalanceChange": true,
      "NetworkMessageFormat": true,
      "PurgeDays": true,
      "ReceiveCardFraudNoteCode": true,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": true,
      "SendNewCardOption": true,
      "SendPinOffsetMessage": true,
      "SuffixFormat": true,
      "ThirdPartyPayments": [
        1
      ],
      "UseMailOverride": true,
      "VauAbuOptOutWarningCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFile": {
    "AvailBalExclList": "text",
    "AvailBalInclOdProtection": true,
    "AvailBalInclOdTolerance": true,
    "CardType": 1,
    "ExcludedStatusReasonCodes": "text",
    "FileRecord": 1,
    "FileType": 1,
    "FileUpdateMethod": 1,
    "FraudControlTrackingType": 1,
    "FwdUpdateToPinNetwork": true,
    "FwdUpdatetoVisaMasterCard": true,
    "HighPriorityMsgOption": 1,
    "InstitutionId": "text",
    "LimitGroupId": "text",
    "MinimumBalanceChange": 1,
    "NetworkMessageFormat": 1,
    "PurgeDays": 1,
    "ReceiveCardFraudNoteCode": 1,
    "SendActivationMessage": true,
    "SendBalances": true,
    "SendCardFraudNoteCode": 1,
    "SendNewCardOption": 1,
    "SendPinOffsetMessage": true,
    "SuffixFormat": 1,
    "ThirdPartyPayments": [
      {
        "EntryId": 1,
        "ThirdPartyPayments": true
      }
    ],
    "UseMailOverride": true,
    "FwdUpdatesfrmOtherNetworks": "text",
    "VauAbuOptOutWarningCode": 1,
    "DigitalIssueTrackingType": 1,
    "BonusAwardsTrackingType": 1,
    "CardFraudNoteExpDays": 1
  }
}

getOnlineFilePagedList

post

Retrieve paged list of online files

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFilePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFile": [
    {
      "AvailBalExclList": "text",
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "CardType": 1,
      "ExcludedStatusReasonCodes": "text",
      "FileRecord": 1,
      "FileType": 1,
      "FileUpdateMethod": 1,
      "FraudControlTrackingType": 1,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": 1,
      "InstitutionId": "text",
      "LimitGroupId": "text",
      "MinimumBalanceChange": 1,
      "NetworkMessageFormat": 1,
      "PurgeDays": 1,
      "ReceiveCardFraudNoteCode": 1,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": 1,
      "SendNewCardOption": 1,
      "SendPinOffsetMessage": true,
      "SuffixFormat": 1,
      "ThirdPartyPayments": [
        {
          "EntryId": 1,
          "ThirdPartyPayments": true
        }
      ],
      "UseMailOverride": true,
      "FwdUpdatesfrmOtherNetworks": "text",
      "VauAbuOptOutWarningCode": 1,
      "DigitalIssueTrackingType": 1,
      "BonusAwardsTrackingType": 1,
      "CardFraudNoteExpDays": 1
    }
  ],
  "Token": "text"
}

getOnlineFileListSelectFields

post

Retrieve online file list select fields

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFileListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1018

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineFileFields": true,
    "OnlineFileFields": {
      "AvailBalExclList": true,
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "BonusAwardsTrackingType": true,
      "CardFraudNoteExpDays": true,
      "CardType": true,
      "DigitalIssueTrackingType": true,
      "ExcludedStatusReasonCodes": true,
      "FileRecord": true,
      "FileType": true,
      "FileUpdateMethod": true,
      "FraudControlTrackingType": true,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatesfrmOtherNetworks": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": true,
      "InstitutionId": true,
      "LimitGroupId": true,
      "MinimumBalanceChange": true,
      "NetworkMessageFormat": true,
      "PurgeDays": true,
      "ReceiveCardFraudNoteCode": true,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": true,
      "SendNewCardOption": true,
      "SendPinOffsetMessage": true,
      "SuffixFormat": true,
      "ThirdPartyPayments": [
        1
      ],
      "UseMailOverride": true,
      "VauAbuOptOutWarningCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFileList": {
    "hasReachedMaximumListSize": true,
    "OnlineFile": [
      {
        "AvailBalExclList": "text",
        "AvailBalInclOdProtection": true,
        "AvailBalInclOdTolerance": true,
        "CardType": 1,
        "ExcludedStatusReasonCodes": "text",
        "FileRecord": 1,
        "FileType": 1,
        "FileUpdateMethod": 1,
        "FraudControlTrackingType": 1,
        "FwdUpdateToPinNetwork": true,
        "FwdUpdatetoVisaMasterCard": true,
        "HighPriorityMsgOption": 1,
        "InstitutionId": "text",
        "LimitGroupId": "text",
        "MinimumBalanceChange": 1,
        "NetworkMessageFormat": 1,
        "PurgeDays": 1,
        "ReceiveCardFraudNoteCode": 1,
        "SendActivationMessage": true,
        "SendBalances": true,
        "SendCardFraudNoteCode": 1,
        "SendNewCardOption": 1,
        "SendPinOffsetMessage": true,
        "SuffixFormat": 1,
        "ThirdPartyPayments": [
          {
            "EntryId": 1,
            "ThirdPartyPayments": true
          }
        ],
        "UseMailOverride": true,
        "FwdUpdatesfrmOtherNetworks": "text",
        "VauAbuOptOutWarningCode": 1,
        "DigitalIssueTrackingType": 1,
        "BonusAwardsTrackingType": 1,
        "CardFraudNoteExpDays": 1
      }
    ]
  }
}

searchOnlineFileSelectFields

post

Retrieve a list of select fields for online files

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchOnlineFileSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1050

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineFileFields": true,
    "OnlineFileFields": {
      "AvailBalExclList": true,
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "BonusAwardsTrackingType": true,
      "CardFraudNoteExpDays": true,
      "CardType": true,
      "DigitalIssueTrackingType": true,
      "ExcludedStatusReasonCodes": true,
      "FileRecord": true,
      "FileType": true,
      "FileUpdateMethod": true,
      "FraudControlTrackingType": true,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatesfrmOtherNetworks": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": true,
      "InstitutionId": true,
      "LimitGroupId": true,
      "MinimumBalanceChange": true,
      "NetworkMessageFormat": true,
      "PurgeDays": true,
      "ReceiveCardFraudNoteCode": true,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": true,
      "SendNewCardOption": true,
      "SendPinOffsetMessage": true,
      "SuffixFormat": true,
      "ThirdPartyPayments": [
        1
      ],
      "UseMailOverride": true,
      "VauAbuOptOutWarningCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFileList": {
    "hasReachedMaximumListSize": true,
    "OnlineFile": [
      {
        "AvailBalExclList": "text",
        "AvailBalInclOdProtection": true,
        "AvailBalInclOdTolerance": true,
        "CardType": 1,
        "ExcludedStatusReasonCodes": "text",
        "FileRecord": 1,
        "FileType": 1,
        "FileUpdateMethod": 1,
        "FraudControlTrackingType": 1,
        "FwdUpdateToPinNetwork": true,
        "FwdUpdatetoVisaMasterCard": true,
        "HighPriorityMsgOption": 1,
        "InstitutionId": "text",
        "LimitGroupId": "text",
        "MinimumBalanceChange": 1,
        "NetworkMessageFormat": 1,
        "PurgeDays": 1,
        "ReceiveCardFraudNoteCode": 1,
        "SendActivationMessage": true,
        "SendBalances": true,
        "SendCardFraudNoteCode": 1,
        "SendNewCardOption": 1,
        "SendPinOffsetMessage": true,
        "SuffixFormat": 1,
        "ThirdPartyPayments": [
          {
            "EntryId": 1,
            "ThirdPartyPayments": true
          }
        ],
        "UseMailOverride": true,
        "FwdUpdatesfrmOtherNetworks": "text",
        "VauAbuOptOutWarningCode": 1,
        "DigitalIssueTrackingType": 1,
        "BonusAwardsTrackingType": 1,
        "CardFraudNoteExpDays": 1
      }
    ]
  }
}

getOnlineFilePagedListSelectFields

post

Retrieve paged list select fields of online files

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFilePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1112

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineFileFields": true,
    "OnlineFileFields": {
      "AvailBalExclList": true,
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "BonusAwardsTrackingType": true,
      "CardFraudNoteExpDays": true,
      "CardType": true,
      "DigitalIssueTrackingType": true,
      "ExcludedStatusReasonCodes": true,
      "FileRecord": true,
      "FileType": true,
      "FileUpdateMethod": true,
      "FraudControlTrackingType": true,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatesfrmOtherNetworks": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": true,
      "InstitutionId": true,
      "LimitGroupId": true,
      "MinimumBalanceChange": true,
      "NetworkMessageFormat": true,
      "PurgeDays": true,
      "ReceiveCardFraudNoteCode": true,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": true,
      "SendNewCardOption": true,
      "SendPinOffsetMessage": true,
      "SuffixFormat": true,
      "ThirdPartyPayments": [
        1
      ],
      "UseMailOverride": true,
      "VauAbuOptOutWarningCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFile": [
    {
      "AvailBalExclList": "text",
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "CardType": 1,
      "ExcludedStatusReasonCodes": "text",
      "FileRecord": 1,
      "FileType": 1,
      "FileUpdateMethod": 1,
      "FraudControlTrackingType": 1,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": 1,
      "InstitutionId": "text",
      "LimitGroupId": "text",
      "MinimumBalanceChange": 1,
      "NetworkMessageFormat": 1,
      "PurgeDays": 1,
      "ReceiveCardFraudNoteCode": 1,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": 1,
      "SendNewCardOption": 1,
      "SendPinOffsetMessage": true,
      "SuffixFormat": 1,
      "ThirdPartyPayments": [
        {
          "EntryId": 1,
          "ThirdPartyPayments": true
        }
      ],
      "UseMailOverride": true,
      "FwdUpdatesfrmOtherNetworks": "text",
      "VauAbuOptOutWarningCode": 1,
      "DigitalIssueTrackingType": 1,
      "BonusAwardsTrackingType": 1,
      "CardFraudNoteExpDays": 1
    }
  ],
  "Token": "text"
}

searchOnlineFilePagedSelectFields

post

Retrieve a paged list of select fields for online files

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchOnlineFilePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1127

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineFileFields": true,
    "OnlineFileFields": {
      "AvailBalExclList": true,
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "BonusAwardsTrackingType": true,
      "CardFraudNoteExpDays": true,
      "CardType": true,
      "DigitalIssueTrackingType": true,
      "ExcludedStatusReasonCodes": true,
      "FileRecord": true,
      "FileType": true,
      "FileUpdateMethod": true,
      "FraudControlTrackingType": true,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatesfrmOtherNetworks": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": true,
      "InstitutionId": true,
      "LimitGroupId": true,
      "MinimumBalanceChange": true,
      "NetworkMessageFormat": true,
      "PurgeDays": true,
      "ReceiveCardFraudNoteCode": true,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": true,
      "SendNewCardOption": true,
      "SendPinOffsetMessage": true,
      "SuffixFormat": true,
      "ThirdPartyPayments": [
        1
      ],
      "UseMailOverride": true,
      "VauAbuOptOutWarningCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFile": [
    {
      "AvailBalExclList": "text",
      "AvailBalInclOdProtection": true,
      "AvailBalInclOdTolerance": true,
      "CardType": 1,
      "ExcludedStatusReasonCodes": "text",
      "FileRecord": 1,
      "FileType": 1,
      "FileUpdateMethod": 1,
      "FraudControlTrackingType": 1,
      "FwdUpdateToPinNetwork": true,
      "FwdUpdatetoVisaMasterCard": true,
      "HighPriorityMsgOption": 1,
      "InstitutionId": "text",
      "LimitGroupId": "text",
      "MinimumBalanceChange": 1,
      "NetworkMessageFormat": 1,
      "PurgeDays": 1,
      "ReceiveCardFraudNoteCode": 1,
      "SendActivationMessage": true,
      "SendBalances": true,
      "SendCardFraudNoteCode": 1,
      "SendNewCardOption": 1,
      "SendPinOffsetMessage": true,
      "SuffixFormat": 1,
      "ThirdPartyPayments": [
        {
          "EntryId": 1,
          "ThirdPartyPayments": true
        }
      ],
      "UseMailOverride": true,
      "FwdUpdatesfrmOtherNetworks": "text",
      "VauAbuOptOutWarningCode": 1,
      "DigitalIssueTrackingType": 1,
      "BonusAwardsTrackingType": 1,
      "CardFraudNoteExpDays": 1
    }
  ],
  "Token": "text"
}

getOnlineFileMgr

post

Retrieve online file manager information

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFileMgr HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFileMgr": {
    "CycleActiveFrom": 1,
    "CycleActiveUntil": 1,
    "JournalFormat": 1,
    "PauseBetweenCycles": 1,
    "HighPriorityFraudTrackType": 1,
    "SaveRejectedMsgsInDialog": true,
    "SendDeleteOnDataException": true
  }
}

getOnlineFileMgrSelectFields

post

Retrieve online file manager select fields

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getOnlineFileMgrSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineFileMgrFields": true,
    "OnlineFileMgrFields": {
      "CycleActiveFrom": true,
      "CycleActiveUntil": true,
      "HighPriorityFraudTrackType": true,
      "JournalFormat": true,
      "PauseBetweenCycles": true,
      "SaveRejectedMsgsInDialog": true,
      "SendDeleteOnDataException": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFileMgr": {
    "CycleActiveFrom": 1,
    "CycleActiveUntil": 1,
    "JournalFormat": 1,
    "PauseBetweenCycles": 1,
    "HighPriorityFraudTrackType": 1,
    "SaveRejectedMsgsInDialog": true,
    "SendDeleteOnDataException": true
  }
}

updateOnlineFileByID

post

Update online files by ID

Authorizations
Body
OnlineFileFileRecordintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateOnlineFileByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFileFileRecord": 1,
  "OnlineFileUpdatableFields": {
    "CardType": 1,
    "FileType": 1,
    "FileUpdateMethod": 1,
    "NetworkMessageFormat": 1,
    "UseMailOverride": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

updateOnlineFileMgrByID

post

Update online file managers by ID

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateOnlineFileMgrByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFileMgrUpdatableFields": {
    "CycleActiveFrom": 1,
    "CycleActiveUntil": 1,
    "HighPriorityFraudTrackType": 1,
    "JournalFormat": 1,
    "PauseBetweenCycles": 1,
    "SaveRejectedMsgsInDialog": true,
    "SendDeleteOnDataException": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}