Skip to content
NexumAPI Docs

PayeeService⁠

Display, create, revise, and delete payee information.

Operations⁠

getPayee⁠

POST

Retrieves detailed information about a payee.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
PayeeNumberstringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/payee/getPayee
POST /nexum/627/2022.01/payee/getPayee HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "0"
}

getPayeeSelectFields⁠

POST

Retrieves selected fields of information for a payee.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
PayeeNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/payee/getPayeeSelectFields
POST /nexum/627/2022.01/payee/getPayeeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "0",
  "SelectableFields": {
    "IncludeAllPayeeFields": true
  }
}

updatePayeeByID⁠

POST

Updates information about a payee based on its ID.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
PayeeNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/payee/updatePayeeByID
POST /nexum/627/2022.01/payee/updatePayeeByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "0",
  "PayeeUpdatableFields": {
    "ContactName": "string"
  }
}

createPayee⁠

POST

Adds a new payee.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
PayeeNumberstringoptional
POST/nexum/{sym}/2022.01/payee/createPayee
POST /nexum/627/2022.01/payee/createPayee HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeCreatableFields": {
    "Number": "0",
    "Name": "string",
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0"
  }
}

deletePayee⁠

POST

Removes an existing payee.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "0"
}