OnlineFee

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineFee

post

Retrieve online fee information

Authorizations
Body
OnlineFeeRuleOrdinalintegerRequired
Responses
200

Successful operation.

application/json
post
/getOnlineFee
POST /nexum/627/2022.01/parameter/getOnlineFee HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

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

Successful operation.

{
  "OnlineFee": {
    "CardTypes": "text",
    "CoOpTransaction": 1,
    "CustomCriterion": 1,
    "ExcludeServiceCodes": "text",
    "FeeCountLevel": 1,
    "FeeCountNumber": 1,
    "FeeCountTotals": 1,
    "FeeDescription": "text",
    "FeeGlCode": 1,
    "FeePostingOption": 1,
    "IncludeServiceCodes": "text",
    "RelationFeeAmount": [
      {
        "EntryId": 1,
        "RelationFeeAmount": 1
      }
    ],
    "RelationRelCodes": [
      {
        "EntryId": 1,
        "RelationRelCodes": "text"
      }
    ],
    "RelationWaiveCount": [
      {
        "EntryId": 1,
        "RelationWaiveCount": 1
      }
    ],
    "RuleDescription": "text",
    "RuleOrdinal": 1,
    "RulePosition": 1,
    "ShareLoan": 1,
    "TerminalTable": 1,
    "TransactionCodes": "text",
    "TransactionTypes": "text",
    "AcquirerNetworkIds": "text"
  }
}

getOnlineFeeSelectFields

post

Retrieve online fee select fields

Authorizations
Body
OnlineFeeRuleOrdinalintegerOptional
Responses
200

Successful operation.

application/json
post
/getOnlineFeeSelectFields
POST /nexum/627/2022.01/parameter/getOnlineFeeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFeeRuleOrdinal": 1,
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AcquirerNetworkIds": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        1
      ],
      "RelationRelCodes": [
        1
      ],
      "RelationWaiveCount": [
        1
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "ShareLoan": true,
      "TerminalTable": true,
      "TransactionCodes": true,
      "TransactionTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFee": {
    "CardTypes": "text",
    "CoOpTransaction": 1,
    "CustomCriterion": 1,
    "ExcludeServiceCodes": "text",
    "FeeCountLevel": 1,
    "FeeCountNumber": 1,
    "FeeCountTotals": 1,
    "FeeDescription": "text",
    "FeeGlCode": 1,
    "FeePostingOption": 1,
    "IncludeServiceCodes": "text",
    "RelationFeeAmount": [
      {
        "EntryId": 1,
        "RelationFeeAmount": 1
      }
    ],
    "RelationRelCodes": [
      {
        "EntryId": 1,
        "RelationRelCodes": "text"
      }
    ],
    "RelationWaiveCount": [
      {
        "EntryId": 1,
        "RelationWaiveCount": 1
      }
    ],
    "RuleDescription": "text",
    "RuleOrdinal": 1,
    "RulePosition": 1,
    "ShareLoan": 1,
    "TerminalTable": 1,
    "TransactionCodes": "text",
    "TransactionTypes": "text",
    "AcquirerNetworkIds": "text"
  }
}

getOnlineFeePagedList

post

Retrieve paged list of online fees

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getOnlineFeePagedList
POST /nexum/627/2022.01/parameter/getOnlineFeePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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.

{
  "OnlineFee": [
    {
      "CardTypes": "text",
      "CoOpTransaction": 1,
      "CustomCriterion": 1,
      "ExcludeServiceCodes": "text",
      "FeeCountLevel": 1,
      "FeeCountNumber": 1,
      "FeeCountTotals": 1,
      "FeeDescription": "text",
      "FeeGlCode": 1,
      "FeePostingOption": 1,
      "IncludeServiceCodes": "text",
      "RelationFeeAmount": [
        {
          "EntryId": 1,
          "RelationFeeAmount": 1
        }
      ],
      "RelationRelCodes": [
        {
          "EntryId": 1,
          "RelationRelCodes": "text"
        }
      ],
      "RelationWaiveCount": [
        {
          "EntryId": 1,
          "RelationWaiveCount": 1
        }
      ],
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "ShareLoan": 1,
      "TerminalTable": 1,
      "TransactionCodes": "text",
      "TransactionTypes": "text",
      "AcquirerNetworkIds": "text"
    }
  ],
  "Token": "text"
}

getOnlineFeeListSelectFields

post

Retrieve online fee list select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getOnlineFeeListSelectFields
POST /nexum/627/2022.01/parameter/getOnlineFeeListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 689

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AcquirerNetworkIds": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        1
      ],
      "RelationRelCodes": [
        1
      ],
      "RelationWaiveCount": [
        1
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "ShareLoan": true,
      "TerminalTable": true,
      "TransactionCodes": true,
      "TransactionTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFeeList": {
    "hasReachedMaximumListSize": true,
    "OnlineFee": [
      {
        "CardTypes": "text",
        "CoOpTransaction": 1,
        "CustomCriterion": 1,
        "ExcludeServiceCodes": "text",
        "FeeCountLevel": 1,
        "FeeCountNumber": 1,
        "FeeCountTotals": 1,
        "FeeDescription": "text",
        "FeeGlCode": 1,
        "FeePostingOption": 1,
        "IncludeServiceCodes": "text",
        "RelationFeeAmount": [
          {
            "EntryId": 1,
            "RelationFeeAmount": 1
          }
        ],
        "RelationRelCodes": [
          {
            "EntryId": 1,
            "RelationRelCodes": "text"
          }
        ],
        "RelationWaiveCount": [
          {
            "EntryId": 1,
            "RelationWaiveCount": 1
          }
        ],
        "RuleDescription": "text",
        "RuleOrdinal": 1,
        "RulePosition": 1,
        "ShareLoan": 1,
        "TerminalTable": 1,
        "TransactionCodes": "text",
        "TransactionTypes": "text",
        "AcquirerNetworkIds": "text"
      }
    ]
  }
}

searchOnlineFeeSelectFields

post

Retrieve a list of select fields for searching by online fee information.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchOnlineFeeSelectFields
POST /nexum/627/2022.01/parameter/searchOnlineFeeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 721

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AcquirerNetworkIds": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        1
      ],
      "RelationRelCodes": [
        1
      ],
      "RelationWaiveCount": [
        1
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "ShareLoan": true,
      "TerminalTable": true,
      "TransactionCodes": true,
      "TransactionTypes": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFeeList": {
    "hasReachedMaximumListSize": true,
    "OnlineFee": [
      {
        "CardTypes": "text",
        "CoOpTransaction": 1,
        "CustomCriterion": 1,
        "ExcludeServiceCodes": "text",
        "FeeCountLevel": 1,
        "FeeCountNumber": 1,
        "FeeCountTotals": 1,
        "FeeDescription": "text",
        "FeeGlCode": 1,
        "FeePostingOption": 1,
        "IncludeServiceCodes": "text",
        "RelationFeeAmount": [
          {
            "EntryId": 1,
            "RelationFeeAmount": 1
          }
        ],
        "RelationRelCodes": [
          {
            "EntryId": 1,
            "RelationRelCodes": "text"
          }
        ],
        "RelationWaiveCount": [
          {
            "EntryId": 1,
            "RelationWaiveCount": 1
          }
        ],
        "RuleDescription": "text",
        "RuleOrdinal": 1,
        "RulePosition": 1,
        "ShareLoan": 1,
        "TerminalTable": 1,
        "TransactionCodes": "text",
        "TransactionTypes": "text",
        "AcquirerNetworkIds": "text"
      }
    ]
  }
}

getOnlineFeePagedListSelectFields

post

Retrieve paged list select fields of online fees

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getOnlineFeePagedListSelectFields
POST /nexum/627/2022.01/parameter/getOnlineFeePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 783

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AcquirerNetworkIds": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        1
      ],
      "RelationRelCodes": [
        1
      ],
      "RelationWaiveCount": [
        1
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "ShareLoan": true,
      "TerminalTable": true,
      "TransactionCodes": true,
      "TransactionTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFee": [
    {
      "CardTypes": "text",
      "CoOpTransaction": 1,
      "CustomCriterion": 1,
      "ExcludeServiceCodes": "text",
      "FeeCountLevel": 1,
      "FeeCountNumber": 1,
      "FeeCountTotals": 1,
      "FeeDescription": "text",
      "FeeGlCode": 1,
      "FeePostingOption": 1,
      "IncludeServiceCodes": "text",
      "RelationFeeAmount": [
        {
          "EntryId": 1,
          "RelationFeeAmount": 1
        }
      ],
      "RelationRelCodes": [
        {
          "EntryId": 1,
          "RelationRelCodes": "text"
        }
      ],
      "RelationWaiveCount": [
        {
          "EntryId": 1,
          "RelationWaiveCount": 1
        }
      ],
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "ShareLoan": 1,
      "TerminalTable": 1,
      "TransactionCodes": "text",
      "TransactionTypes": "text",
      "AcquirerNetworkIds": "text"
    }
  ],
  "Token": "text"
}

searchOnlineFeePagedSelectFields

post

Retrieve a list of paged select fields for searching by online fee information.

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchOnlineFeePagedSelectFields
POST /nexum/627/2022.01/parameter/searchOnlineFeePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 798

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineFeeFields": true,
    "OnlineFeeFields": {
      "AcquirerNetworkIds": true,
      "CardTypes": true,
      "CoOpTransaction": true,
      "CustomCriterion": true,
      "ExcludeServiceCodes": true,
      "FeeCountLevel": true,
      "FeeCountNumber": true,
      "FeeCountTotals": true,
      "FeeDescription": true,
      "FeeGlCode": true,
      "FeePostingOption": true,
      "IncludeServiceCodes": true,
      "RelationFeeAmount": [
        1
      ],
      "RelationRelCodes": [
        1
      ],
      "RelationWaiveCount": [
        1
      ],
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "ShareLoan": true,
      "TerminalTable": true,
      "TransactionCodes": true,
      "TransactionTypes": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineFee": [
    {
      "CardTypes": "text",
      "CoOpTransaction": 1,
      "CustomCriterion": 1,
      "ExcludeServiceCodes": "text",
      "FeeCountLevel": 1,
      "FeeCountNumber": 1,
      "FeeCountTotals": 1,
      "FeeDescription": "text",
      "FeeGlCode": 1,
      "FeePostingOption": 1,
      "IncludeServiceCodes": "text",
      "RelationFeeAmount": [
        {
          "EntryId": 1,
          "RelationFeeAmount": 1
        }
      ],
      "RelationRelCodes": [
        {
          "EntryId": 1,
          "RelationRelCodes": "text"
        }
      ],
      "RelationWaiveCount": [
        {
          "EntryId": 1,
          "RelationWaiveCount": 1
        }
      ],
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "ShareLoan": 1,
      "TerminalTable": 1,
      "TransactionCodes": "text",
      "TransactionTypes": "text",
      "AcquirerNetworkIds": "text"
    }
  ],
  "Token": "text"
}

updateOnlineFeeByID

post

Update online fees by ID

Authorizations
Body
OnlineFeeRuleOrdinalintegerOptional
Responses
200

Successful operation.

application/json
post
/updateOnlineFeeByID
POST /nexum/627/2022.01/parameter/updateOnlineFeeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 743

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineFeeRuleOrdinal": 1,
  "OnlineFeeUpdatableFields": {
    "AcquirerNetworkIds": "text",
    "CardTypes": "text",
    "CoOpTransaction": 1,
    "CustomCriterion": 1,
    "ExcludeServiceCodes": "text",
    "FeeCountLevel": 1,
    "FeeCountNumber": 1,
    "FeeCountTotals": 1,
    "FeeDescription": "text",
    "FeeGlCode": 1,
    "FeePostingOption": 1,
    "IncludeServiceCodes": "text",
    "RelationFeeAmount": [
      {
        "EntryId": 1,
        "RelationFeeAmount": 1
      }
    ],
    "RelationRelCodes": [
      {
        "EntryId": 1,
        "RelationRelCodes": "text"
      }
    ],
    "RelationWaiveCount": [
      {
        "EntryId": 1,
        "RelationWaiveCount": 1
      }
    ],
    "RuleDescription": "text",
    "RulePosition": 1,
    "ShareLoan": 1,
    "TerminalTable": 1,
    "TransactionCodes": "text",
    "TransactionTypes": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?