Skip to content
NexumAPI Docs

OnlineFile⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineFileSelectFields⁠

POST

Execute the persistent ParameterService getOnlineFileSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
OnlineFileFileRecordintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getOnlineFileSelectFields
POST /nexum/627/persistent/parameter/getOnlineFileSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineFileFileRecord": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineFilePagedListSelectFields⁠

POST

Execute the persistent ParameterService getOnlineFilePagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getOnlineFilePagedListSelectFields
POST /nexum/627/persistent/parameter/getOnlineFilePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchOnlineFilePagedSelectFields⁠

POST

Execute the persistent ParameterService searchOnlineFilePagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchOnlineFilePagedSelectFields
POST /nexum/627/persistent/parameter/searchOnlineFilePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "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
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineFileByID⁠

POST

Execute the persistent ParameterService updateOnlineFileByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
OnlineFileFileRecordintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateOnlineFileByID
POST /nexum/627/persistent/parameter/updateOnlineFileByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineFileFileRecord": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineFileFields": {
    "AvailBalExclList": "string",
    "AvailBalInclOdProtection": true,
    "AvailBalInclOdTolerance": true,
    "BonusAwardsTrackingType": 0,
    "CardFraudNoteExpDays": 0,
    "CardType": 0,
    "DigitalIssueTrackingType": 0,
    "ExcludedStatusReasonCodes": "string",
    "FileRecord": 0,
    "FileType": 0,
    "FileUpdateMethod": 0,
    "FraudControlTrackingType": 0,
    "FwdUpdateToPinNetwork": true,
    "FwdUpdatesfrmOtherNetworks": "string",
    "FwdUpdatetoVisaMasterCard": true,
    "HighPriorityMsgOption": 0,
    "InstitutionId": "string",
    "LimitGroupId": "string",
    "MinimumBalanceChange": 0,
    "NetworkMessageFormat": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineFileMgrSelectFields⁠

POST

Execute the persistent ParameterService getOnlineFileMgrSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getOnlineFileMgrSelectFields
POST /nexum/627/persistent/parameter/getOnlineFileMgrSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllOnlineFileMgrFields": true,
    "OnlineFileMgrFields": {
      "CycleActiveFrom": true,
      "CycleActiveUntil": true,
      "HighPriorityFraudTrackType": true,
      "JournalFormat": true,
      "PauseBetweenCycles": true,
      "SaveRejectedMsgsInDialog": true,
      "SendDeleteOnDataException": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineFileMgrByID⁠

POST

Execute the persistent ParameterService updateOnlineFileMgrByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateOnlineFileMgrByID
POST /nexum/627/persistent/parameter/updateOnlineFileMgrByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineFileMgrFields": {
    "CycleActiveFrom": 0,
    "CycleActiveUntil": 0,
    "HighPriorityFraudTrackType": 0,
    "JournalFormat": 0,
    "PauseBetweenCycles": 0,
    "SaveRejectedMsgsInDialog": true,
    "SendDeleteOnDataException": true
  },
  "nxAttributes": {
    "customFields": {}
  }
}