Skip to content
NexumAPI Docs

Preference⁠

Perform various operations on preference records.

Operations⁠

searchPreferenceAccessPagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllPreferenceAccessFields": false,
    "PreferenceAccessFields": {
      "Locator": true,
      "AccessType": true,
      "AccountNumber": true,
      "Id": true,
      "IdType": true,
      "EnableInquiry": true,
      "EnableDeposit": true,
      "EnableWithdrawal": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updatePreferenceByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PreferenceFields": {
    "Type": 0,
    "HbUsername": "string",
    "HbEnable": 0,
    "AudioEnable": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updatePreferenceAccessByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PreferenceAccessLocator": 0,
  "PreferenceAccessFields": {
    "AccessType": 0,
    "AccountNumber": "0000000000",
    "IdType": 0,
    "Id": "0",
    "EnableInquiry": 0,
    "EnableDeposit": 0,
    "EnableWithdrawal": 0,
    "EnableFm": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createPreference⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceFields": {
    "Type": 0,
    "HbUsername": "string",
    "HbEnable": 0,
    "AudioEnable": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createPreferenceAccess⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "PreferenceAccessFields": {
    "AccessType": 0,
    "AccountNumber": "0000000000",
    "IdType": 0,
    "Id": "0",
    "EnableInquiry": 0,
    "EnableDeposit": 0,
    "EnableWithdrawal": 0,
    "EnableFm": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deletePreference⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
PreferenceLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/persistent/account/deletePreference
POST /nexum/627/persistent/account/deletePreference HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PreferenceLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}