OnlineSbAddOn

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineSbAddOn

post

Online sb add on

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineSbAddOnRuleOrdinalintegerRequired

Responses

200

Successful operation.

application/json

post

/getOnlineSbAddOn

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineSbAddOn": {
    "AvailBalApprExclList": "text",
    "AvailBalPostExclList": "text",
    "CardAcceptorLocation": "text",
    "CardAcceptorName": "text",
    "CheckDepositHolds": 1,
    "CustomCriterion": 1,
    "GlCode": 1,
    "NonIrsCertTranAccess": true,
    "NonIrsClubTranAccess": true,
    "PosConditionCodes": "text",
    "RegDLimiting": true,
    "RuleDescription": "text",
    "RuleOrdinal": 1,
    "RulePosition": 1,
    "TransactionHistoryPrefix": "text",
    "TransactionSourceCode": "text",
    "TransactionSubType": 1
  }
}

getOnlineSbAddOnSelectFields

post

Online sb add on select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineSbAddOnRuleOrdinalintegerOptional

Responses

200

Successful operation.

application/json

post

/getOnlineSbAddOnSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineSbAddOnRuleOrdinal": 1,
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "GlCode": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true,
      "TransactionSubType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineSbAddOn": {
    "AvailBalApprExclList": "text",
    "AvailBalPostExclList": "text",
    "CardAcceptorLocation": "text",
    "CardAcceptorName": "text",
    "CheckDepositHolds": 1,
    "CustomCriterion": 1,
    "GlCode": 1,
    "NonIrsCertTranAccess": true,
    "NonIrsClubTranAccess": true,
    "PosConditionCodes": "text",
    "RegDLimiting": true,
    "RuleDescription": "text",
    "RuleOrdinal": 1,
    "RulePosition": 1,
    "TransactionHistoryPrefix": "text",
    "TransactionSourceCode": "text",
    "TransactionSubType": 1
  }
}

getOnlineSbAddOnPagedList

post

Online sb add on paged list

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineSbAddOnPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineSbAddOnPagedList 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.

{
  "OnlineSbAddOn": [
    {
      "AvailBalApprExclList": "text",
      "AvailBalPostExclList": "text",
      "CardAcceptorLocation": "text",
      "CardAcceptorName": "text",
      "CheckDepositHolds": 1,
      "CustomCriterion": 1,
      "GlCode": 1,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": "text",
      "RegDLimiting": true,
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "TransactionHistoryPrefix": "text",
      "TransactionSourceCode": "text",
      "TransactionSubType": 1
    }
  ],
  "Token": "text"
}

getOnlineSbAddOnListSelectFields

post

Online sb add on list select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineSbAddOnListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "GlCode": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true,
      "TransactionSubType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineSbAddOnList": {
    "hasReachedMaximumListSize": true,
    "OnlineSbAddOn": [
      {
        "AvailBalApprExclList": "text",
        "AvailBalPostExclList": "text",
        "CardAcceptorLocation": "text",
        "CardAcceptorName": "text",
        "CheckDepositHolds": 1,
        "CustomCriterion": 1,
        "GlCode": 1,
        "NonIrsCertTranAccess": true,
        "NonIrsClubTranAccess": true,
        "PosConditionCodes": "text",
        "RegDLimiting": true,
        "RuleDescription": "text",
        "RuleOrdinal": 1,
        "RulePosition": 1,
        "TransactionHistoryPrefix": "text",
        "TransactionSourceCode": "text",
        "TransactionSubType": 1
      }
    ]
  }
}

searchOnlineSbAddOnSelectFields

post

Retrieve a list of select fields for online Small Business add-ons

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/searchOnlineSbAddOnSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "GlCode": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true,
      "TransactionSubType": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineSbAddOnList": {
    "hasReachedMaximumListSize": true,
    "OnlineSbAddOn": [
      {
        "AvailBalApprExclList": "text",
        "AvailBalPostExclList": "text",
        "CardAcceptorLocation": "text",
        "CardAcceptorName": "text",
        "CheckDepositHolds": 1,
        "CustomCriterion": 1,
        "GlCode": 1,
        "NonIrsCertTranAccess": true,
        "NonIrsClubTranAccess": true,
        "PosConditionCodes": "text",
        "RegDLimiting": true,
        "RuleDescription": "text",
        "RuleOrdinal": 1,
        "RulePosition": 1,
        "TransactionHistoryPrefix": "text",
        "TransactionSourceCode": "text",
        "TransactionSubType": 1
      }
    ]
  }
}

getOnlineSbAddOnPagedListSelectFields

post

Online sb add on paged list select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineSbAddOnPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "GlCode": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true,
      "TransactionSubType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineSbAddOn": [
    {
      "AvailBalApprExclList": "text",
      "AvailBalPostExclList": "text",
      "CardAcceptorLocation": "text",
      "CardAcceptorName": "text",
      "CheckDepositHolds": 1,
      "CustomCriterion": 1,
      "GlCode": 1,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": "text",
      "RegDLimiting": true,
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "TransactionHistoryPrefix": "text",
      "TransactionSourceCode": "text",
      "TransactionSubType": 1
    }
  ],
  "Token": "text"
}

searchOnlineSbAddOnPagedSelectFields

post

Retrieve a paged list of select fields for online Small Business add-ons

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchOnlineSbAddOnPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineSbAddOnFields": true,
    "OnlineSbAddOnFields": {
      "AvailBalApprExclList": true,
      "AvailBalPostExclList": true,
      "CardAcceptorLocation": true,
      "CardAcceptorName": true,
      "CheckDepositHolds": true,
      "CustomCriterion": true,
      "GlCode": true,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": true,
      "RegDLimiting": true,
      "RuleDescription": true,
      "RuleOrdinal": true,
      "RulePosition": true,
      "TransactionHistoryPrefix": true,
      "TransactionSourceCode": true,
      "TransactionSubType": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineSbAddOn": [
    {
      "AvailBalApprExclList": "text",
      "AvailBalPostExclList": "text",
      "CardAcceptorLocation": "text",
      "CardAcceptorName": "text",
      "CheckDepositHolds": 1,
      "CustomCriterion": 1,
      "GlCode": 1,
      "NonIrsCertTranAccess": true,
      "NonIrsClubTranAccess": true,
      "PosConditionCodes": "text",
      "RegDLimiting": true,
      "RuleDescription": "text",
      "RuleOrdinal": 1,
      "RulePosition": 1,
      "TransactionHistoryPrefix": "text",
      "TransactionSourceCode": "text",
      "TransactionSubType": 1
    }
  ],
  "Token": "text"
}

updateOnlineSbAddOnByID

post

Update online SB add-ons by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineSbAddOnRuleOrdinalintegerOptional

Responses

200

Successful operation.

application/json

post

/updateOnlineSbAddOnByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineSbAddOnRuleOrdinal": 1,
  "OnlineSbAddOnUpdatableFields": {
    "AvailBalApprExclList": "text",
    "AvailBalPostExclList": "text",
    "CardAcceptorLocation": "text",
    "CardAcceptorName": "text",
    "CheckDepositHolds": 1,
    "CustomCriterion": 1,
    "GlCode": 1,
    "NonIrsCertTranAccess": true,
    "NonIrsClubTranAccess": true,
    "PosConditionCodes": "text",
    "RegDLimiting": true,
    "RuleDescription": "text",
    "RulePosition": 1,
    "TransactionHistoryPrefix": "text",
    "TransactionSourceCode": "text",
    "TransactionSubType": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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