Skip to content
NexumAPI Docs

OnlineFee⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineFeeSelectFields⁠

POST

Execute the persistent ParameterService getOnlineFeeSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "OnlineFeeRuleOrdinal": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AccountTypes": true,
      "AcquirerNetworkIds": true,
      "CardAcceptorName": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        0
      ],
      "RelationRelCodes": [
        0
      ],
      "RelationWaiveCount": [
        0
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineFeePagedListSelectFields⁠

POST

Execute the persistent ParameterService getOnlineFeePagedListSelectFields 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/getOnlineFeePagedListSelectFields
POST /nexum/627/persistent/parameter/getOnlineFeePagedListSelectFields 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": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AccountTypes": true,
      "AcquirerNetworkIds": true,
      "CardAcceptorName": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        0
      ],
      "RelationRelCodes": [
        0
      ],
      "RelationWaiveCount": [
        0
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchOnlineFeePagedSelectFields⁠

POST

Execute the persistent ParameterService searchOnlineFeePagedSelectFields 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/searchOnlineFeePagedSelectFields
POST /nexum/627/persistent/parameter/searchOnlineFeePagedSelectFields 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": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AccountTypes": true,
      "AcquirerNetworkIds": true,
      "CardAcceptorName": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        0
      ],
      "RelationRelCodes": [
        0
      ],
      "RelationWaiveCount": [
        0
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineFeeByID⁠

POST

Execute the persistent ParameterService updateOnlineFeeByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "OnlineFeeRuleOrdinal": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineFeeFields": {
    "AccountTypes": {
      "Bit": [
        0
      ]
    },
    "AcquirerNetworkIds": "string",
    "CardAcceptorName": "string",
    "CardTypes": {
      "Bit": [
        0
      ]
    },
    "CoOpTransaction": 0,
    "CustomCriterion": 0,
    "ExcludeServiceCodes": {
      "Bit": [
        0
      ]
    },
    "FeeCountLevel": 0,
    "FeeCountNumber": 0,
    "FeeCountTotals": 0,
    "FeeDescription": "string",
    "FeeGlCode": 0,
    "FeePostingOption": 0,
    "IncludeServiceCodes": {
      "Bit": [
        0
      ]
    },
    "RelationFeeAmount": [
      {
        "EntryId": 0,
        "RelationFeeAmount": 0
      }
    ],
    "RelationRelCodes": [
      {
        "EntryId": 0,
        "RelationRelCodes": {
          "Bit": [
            0
          ]
        }
      }
    ],
    "RelationWaiveCount": [
      {
        "EntryId": 0,
        "RelationWaiveCount": 0
      }
    ],
    "RuleDescription": "string",
    "RuleOrdinal": 0,
    "RulePosition": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}