Skip to content
NexumAPI Docs

OnlineSbAddOn⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineSbAddOnSelectFields⁠

POST

Execute the persistent ParameterService getOnlineSbAddOnSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "OnlineSbAddOnRuleOrdinal": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "DepRestrictWarnList": true,
      "GlCode": true,
      "LnExcludeTypeList": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RestrictWarnList": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "SvExcludeTypeList": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineSbAddOnPagedListSelectFields⁠

POST

Execute the persistent ParameterService getOnlineSbAddOnPagedListSelectFields 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/getOnlineSbAddOnPagedListSelectFields
POST /nexum/627/persistent/parameter/getOnlineSbAddOnPagedListSelectFields 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": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "DepRestrictWarnList": true,
      "GlCode": true,
      "LnExcludeTypeList": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RestrictWarnList": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "SvExcludeTypeList": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchOnlineSbAddOnPagedSelectFields⁠

POST

Execute the persistent ParameterService searchOnlineSbAddOnPagedSelectFields 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/searchOnlineSbAddOnPagedSelectFields
POST /nexum/627/persistent/parameter/searchOnlineSbAddOnPagedSelectFields 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": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "DepRestrictWarnList": true,
      "GlCode": true,
      "LnExcludeTypeList": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RestrictWarnList": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "SvExcludeTypeList": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineSbAddOnByID⁠

POST

Execute the persistent ParameterService updateOnlineSbAddOnByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "OnlineSbAddOnRuleOrdinal": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineSbAddOnFields": {
    "AvailBalApprExclList": {
      "Bit": [
        0
      ]
    },
    "AvailBalPostExclList": {
      "Bit": [
        0
      ]
    },
    "CardAcceptorLocation": "string",
    "CardAcceptorName": "string",
    "CheckDepositHolds": 0,
    "CustomCriterion": 0,
    "DepRestrictWarnList": {
      "Bit": [
        0
      ]
    },
    "GlCode": 0,
    "LnExcludeTypeList": {
      "Bit": [
        0
      ]
    },
    "NonIrsCertTranAccess": true,
    "NonIrsClubTranAccess": true,
    "PosConditionCodes": "string",
    "RegDLimiting": true,
    "RestrictWarnList": {
      "Bit": [
        0
      ]
    },
    "RuleDescription": "string",
    "RuleOrdinal": 0,
    "RulePosition": 0,
    "SvExcludeTypeList": {
      "Bit": [
        0
      ]
    },
    "TransactionHistoryPrefix": "string",
    "TransactionSourceCode": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}