CashMachines

Manage cash machines.

Symitar eDocs References: Coming soon.

Operations

contentsReport

post

Generates a report on the contents of the cash machine.

Authorizations
Body
timeoutintegerOptional
Responses
200

Successful operation.

application/json
post
/contentsReport
POST /nexum/627/2022.01/cashmachines/contentsReport HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

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
  }
}

dispense

post

Dispenses cash from the cash machine.

Authorizations
Body
timeoutintegerOptional
duressFlagbooleanOptional
Responses
200

Successful operation.

application/json
post
/dispense
POST /nexum/627/2022.01/cashmachines/dispense HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

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
  }
}

startDeposit

post

Initiates the deposit process at the cash machine.

Authorizations
Body
timeoutintegerOptional
Responses
200

Successful operation.

application/json
post
/startDeposit
POST /nexum/627/2022.01/cashmachines/startDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

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
  }
}

continueDeposit

post

Allows the cash machine to continue a deposit process.

Authorizations
Body
timeoutintegerRequired
Responses
200

Successful operation.

application/json
post
/continueDeposit
POST /nexum/627/2022.01/cashmachines/continueDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

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
  }
}

acceptDeposit

post

Allows the cash machine to accept a deposit.

Authorizations
Body
timeoutintegerRequired
Responses
200

Successful operation.

application/json
post
/acceptDeposit
POST /nexum/627/2022.01/cashmachines/acceptDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

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
  }
}

rejectDeposit

post

Rejects a deposit at the cash machine.

Authorizations
Body
timeoutintegerOptional
Responses
200

Successful operation.

application/json
post
/rejectDeposit
POST /nexum/627/2022.01/cashmachines/rejectDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "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
  }
}

cassetteReport

post

Generates a report on the status of cassettes in the cash machine.

Authorizations
Body
timeoutintegerOptional
Responses
200

Successful operation.

application/json
post
/cassetteReport
POST /nexum/627/2022.01/cashmachines/cassetteReport HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "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
    }
  ]
}

cassetteAdjustment

post

Adjusts the cassettes in the cash machine.

Authorizations
Body
timeoutintegerOptional
cassetteCountintegerOptional
coinAmountintegerOptional
Responses
200

Successful operation.

application/json
post
/cassetteAdjustment
POST /nexum/627/2022.01/cashmachines/cassetteAdjustment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "returnInfo": {
    "errorLevel": "text",
    "errorCode": "text",
    "longDescription": "text",
    "httpLink": "text"
  }
}

remoteDispense

post

Dispenses cash remotely, often initiated through an app or online banking.

Authorizations
Body
timeoutintegerOptional
duressFlagbooleanOptional
Responses
200

Successful operation.

application/json
post
/remoteDispense
POST /nexum/627/2022.01/cashmachines/remoteDispense HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "remoteReturnInfo": {
    "remoteTranId": 1,
    "remoteTranPin": "text",
    "remoteTranStatus": "text",
    "remoteTranPhysicalDeviceName": "text",
    "errorLevel": "text",
    "errorCode": "text",
    "longDescription": "text",
    "httpLink": "text"
  }
}

remoteTransactionInquiry

post

Inquires about the status of a remote transaction initiated via an app or online banking.

Authorizations
Body
tranTypestringOptional
timeoutintegerOptional
remoteTransactionIdintegerOptional
pinstringOptional
Responses
200

Successful operation.

application/json
post
/remoteTransactionInquiry
POST /nexum/627/2022.01/cashmachines/remoteTransactionInquiry HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "remoteReturnInfo": {
    "remoteTranId": 1,
    "remoteTranPin": "text",
    "remoteTranStatus": "text",
    "remoteTranPhysicalDeviceName": "text",
    "errorLevel": "text",
    "errorCode": "text",
    "longDescription": "text",
    "httpLink": "text"
  }
}

remoteTransactionCancel

post

Cancels a remote transaction initiated via an app or online banking.

Authorizations
Body
tranTypestringOptional
timeoutintegerOptional
remoteTransactionIdintegerOptional
pinstringOptional
Responses
200

Successful operation.

application/json
post
/remoteTransactionCancel
POST /nexum/627/2022.01/cashmachines/remoteTransactionCancel HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "remoteReturnInfo": {
    "remoteTranId": 1,
    "remoteTranPin": "text",
    "remoteTranStatus": "text",
    "remoteTranPhysicalDeviceName": "text",
    "errorLevel": "text",
    "errorCode": "text",
    "longDescription": "text",
    "httpLink": "text"
  }
}

remoteTransactionComplete

post

Completes a remote transaction initiated via an app or online banking.

Authorizations
Body
tranTypestringOptional
timeoutintegerOptional
remoteTransactionIdintegerOptional
pinstringOptional
Responses
200

Successful operation.

application/json
post
/remoteTransactionComplete
POST /nexum/627/2022.01/cashmachines/remoteTransactionComplete HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "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
  }
}

remoteDeposit

post

Facilitates deposit remotely, usually via an app or online banking.

Authorizations
Body
timeoutintegerOptional
Responses
200

Successful operation.

application/json
post
/remoteDeposit
POST /nexum/627/2022.01/cashmachines/remoteDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "remoteReturnInfo": {
    "remoteTranId": 1,
    "remoteTranPin": "text",
    "remoteTranStatus": "text",
    "remoteTranPhysicalDeviceName": "text",
    "errorLevel": "text",
    "errorCode": "text",
    "longDescription": "text",
    "httpLink": "text"
  }
}
PreviousCashLetterServiceNextCheckService

Last updated

Was this helpful?