Last updated 10 months ago
Was this helpful?
Manage cash machines.
Symitar eDocs References: Coming soon.
Generates a report on the contents of the cash machine.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/cashmachines/contentsReport HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 203 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "Status": { "StatusCode": 1, "Message": "text" }, "returnInfo": { "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" }, "actualDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 } }
Dispenses cash from the cash machine.
POST /nexum/627/2022.01/cashmachines/dispense HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 335 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "requestedDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 }, "duressFlag": true, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Initiates the deposit process at the cash machine.
POST /nexum/627/2022.01/cashmachines/startDeposit HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 203 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Allows the cash machine to continue a deposit process.
POST /nexum/627/2022.01/cashmachines/continueDeposit HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 136 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Allows the cash machine to accept a deposit.
POST /nexum/627/2022.01/cashmachines/acceptDeposit HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 136 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Rejects a deposit at the cash machine.
POST /nexum/627/2022.01/cashmachines/rejectDeposit HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 249 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "timeout": 1, "retainedDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "StatusCode": 1, "Message": "text" }, "returnInfo": { "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" }, "retainedDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 } }
Generates a report on the status of cassettes in the cash machine.
POST /nexum/627/2022.01/cashmachines/cassetteReport HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 203 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "StatusCode": 1, "Message": "text" }, "returnInfo": { "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" }, "cassetteCount": 1, "currentCassettes": [ { "id": "text", "notes": 1, "value": 1, "denom": 1 } ] }
Adjusts the cassettes in the cash machine.
POST /nexum/627/2022.01/cashmachines/cassetteAdjustment HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 294 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "cassetteCount": 1, "cassettes": [ { "id": "text", "notes": 1, "value": 1, "denom": 1 } ], "coinAmount": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "StatusCode": 1, "Message": "text" }, "returnInfo": { "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" } }
Dispenses cash remotely, often initiated through an app or online banking.
POST /nexum/627/2022.01/cashmachines/remoteDispense HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 335 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "requestedDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 }, "duressFlag": true, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "StatusCode": 1, "Message": "text" }, "remoteReturnInfo": { "remoteTranId": 1, "remoteTranPin": "text", "remoteTranStatus": "text", "remoteTranPhysicalDeviceName": "text", "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" } }
Inquires about the status of a remote transaction initiated via an app or online banking.
POST /nexum/627/2022.01/cashmachines/remoteTransactionInquiry HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 258 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "tranType": "text", "timeout": 1, "remoteTransactionId": 1, "pin": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Cancels a remote transaction initiated via an app or online banking.
POST /nexum/627/2022.01/cashmachines/remoteTransactionCancel HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 258 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "tranType": "text", "timeout": 1, "remoteTransactionId": 1, "pin": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Completes a remote transaction initiated via an app or online banking.
POST /nexum/627/2022.01/cashmachines/remoteTransactionComplete HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 258 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "tranType": "text", "timeout": 1, "remoteTransactionId": 1, "pin": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "Status": { "StatusCode": 1, "Message": "text" }, "remoteReturnInfo": { "remoteTranId": 1, "remoteTranPin": "text", "remoteTranStatus": "text", "remoteTranPhysicalDeviceName": "text", "errorLevel": "text", "errorCode": "text", "longDescription": "text", "httpLink": "text" }, "actualDistribution": { "totalAmount": 1, "billDenominations": [ 1 ], "billCount": [ 1 ], "billStatus": [ 1 ], "coinAmount": 1 } }
Facilitates deposit remotely, usually via an app or online banking.
POST /nexum/627/2022.01/cashmachines/remoteDeposit HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 203 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "device": { "deviceName": "text", "orientation": 1, "recyclerFlag": true }, "timeout": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
