Skip to content
NexumAPI Docs

CashMachines⁠

Manage cash machines.

Operations⁠

contentsReport⁠

POST

Generates a report on the contents of the cash machine.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "device": {},
  "timeout": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

dispense⁠

POST

Dispenses cash from the cash machine.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "device": {},
  "timeout": 0,
  "requestedDistribution": {},
  "duressFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

startDeposit⁠

POST

Initiates the deposit process at the cash machine.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "device": {},
  "timeout": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

continueDeposit⁠

POST

Allows the cash machine to continue a deposit process.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "timeout": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

acceptDeposit⁠

POST

Allows the cash machine to accept a deposit.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "timeout": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

rejectDeposit⁠

POST

Rejects a deposit at the cash machine.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "timeout": 0,
  "retainedDistribution": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}