API docs by Redocly

Asset API (1.0.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com/ License: MIT

API for managing Amusement Connect assets

Kiosks

Kiosks

Get Kiosk

Authorizations:
apiKey
path Parameters
kioskId
required
string

The unique identifier of the kiosk.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "softwareVersion": "string",
  • "iotHubConnectionString": "string",
  • "theme": {
    },
  • "transactionSettings": {
    }
}

Get a kiosks payment configuration by ID

Authorizations:
apiKey
path Parameters
kioskId
required
string

The unique identifier of the kiosk.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "datacapHostOrIp": "string",
  • "datacapDeploymentId": "string",
  • "datacapMerchantId": "string",
  • "datacapSecureDevice": "string",
  • "creditCardDeviceConfig": {
    }
}

Update Kiosk Square Payment Configuration

Authorizations:
apiKey
path Parameters
kioskId
required
string

The unique identifier of the kiosk.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
accessToken
string <= 5000 characters
squareDeviceId
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "squareDeviceId": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Update Kiosk Shift4 Payment Configuration

Authorizations:
apiKey
path Parameters
kioskId
required
string

The unique identifier of the kiosk.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
shift4MerchantId
string <= 128 characters
shift4TerminalId
string <= 128 characters
shift4LocationId
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "shift4MerchantId": "string",
  • "shift4TerminalId": "string",
  • "shift4LocationId": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Update Kiosk Datacap Payment Configuration

Authorizations:
apiKey
path Parameters
kioskId
required
string

The unique identifier of the kiosk.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
datacapHostOrIp
string <= 128 characters
datacapDeploymentId
string <= 128 characters
datacapMerchantId
string <= 128 characters
datacapSecureDevice
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "datacapHostOrIp": "string",
  • "datacapDeploymentId": "string",
  • "datacapMerchantId": "string",
  • "datacapSecureDevice": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Collection

Collection

Create a new collection

Creates a new collection event for the location. This represents the someone going to the assets at the location and physically collecting any bills, coins, or other valuables. Using the previous collection the system can calculate the expected value of the collection and can be used to detect any discrepancies. Any mobile mechs at this location will be asked to report their current meters.

Collection periods will go back to the previous collection, the first transaction of the system, or 90 days ago. Whichever is first.

The collection timestamp can optionally be provided to record a collection that was recently made but not immediately reported.

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
locationId
string <uuid>

The unique identifier of the location.

collectedUtc
string or null <date-time>

UTC Timestamp for the collection event. If not provided the current utc time is used. When provided it must be after the previous collection and must not be in the future.

Responses

Request samples

Content type
application/json
{
  • "locationId": "00000000-0000-0000-0000-000000000000",
  • "collectedUtc": "2025-07-20T12:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "collectionId": "00000000-0000-0000-0000-000000000000"
}

List collections for a location

A filterable, paginated list of collections at a location

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

query Parameters
top
integer
Example: top=10

The maximum number of records to return in the response. If not specified, all records are returned.

skip
integer
Example: skip=10

The number of records to skip in the response. If not specified, no records are skipped.

orderBy
string
Example: orderBy=name desc

A comma-separated list of fields to order the response by. If not specified, the response is not ordered.

apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 20,
  • "totalCount": 100,
  • "_links": [
    ]
}

Get a collection by ID

Retrieves a specific collection by its unique identifier.

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

collectionId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the collection.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "collectionStartUtc": "2025-07-19T12:00:00.000Z",
  • "collectedUtc": "2025-07-20T12:00:00.000Z",
  • "recordedUtc": "2025-07-20T12:30:00.000Z",
  • "reportType": "kiosk",
  • "collectedBy": {
    },
  • "_links": [
    ]
}

Delete a collection by ID

Deletes a specific collection by its unique identifier. The operation will fail if the collection isn't the most recent.

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

collectionId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the collection.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    }
}

Get cashbox data since last collection

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "lastCollectionId": "0da55673-feda-4086-ad48-352004c5dd7c",
  • "lastCollectionDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencySymbol": "string",
  • "lstMobileConnectReport": [ ],
  • "sumCashTransactions": "string",
  • "sumCreditTransactions": "string",
  • "countCashTransactions": 0,
  • "countCreditTransactions": 0,
  • "countSpecialTransactions": 0,
  • "sumSpecialTransactions": "string",
  • "countSpecialTransactionsUsed": 0,
  • "sumSpecialTransactionsUsed": "string",
  • "sumSpecialTransactionsActualAmt": "string",
  • "sumCashRefundTransactions": "string",
  • "countCashRefundTransactions": 0,
  • "sumCreditRefundTransactions": "string",
  • "countCreditRefundTransactions": 0,
  • "sumRefundTransactions": "string",
  • "countRefundTransactions": 0,
  • "sumFreePlayTransactions": "string",
  • "countFreePlayTransactions": 0,
  • "strFreePlayTimeDifference": "string",
  • "countGiftFreePlayTransactions": 0,
  • "strFreePlayGiftCardTimeDifference": "string",
  • "sumGiftFreePlayTransactionsActualAmt": "string",
  • "sumCreditAddedTransactions": 0.1,
  • "sumCreditRemovedTransactions": 0.1,
  • "countCreditAddedTransactions": 0,
  • "countCreditRemovedTransactions": 0,
  • "sumTicketAddedTransactions": 0.1,
  • "sumTicketRemovedTransactions": 0.1,
  • "countTicketAddedTransactions": 0,
  • "countTicketRemovedTransactions": 0,
  • "sumPrizeHubTransactions": 0.1,
  • "countPrizeHubTransactions": 0,
  • "payStationCash": "string",
  • "payStationCredit": "string",
  • "posCash": "string",
  • "posCredit": "string",
  • "manualCash": "string",
  • "manualCredit": "string",
  • "payStationCashCount": 0,
  • "payStationCreditCount": 0,
  • "posCashCount": 0,
  • "posCreditCount": 0,
  • "manualCashCount": 0,
  • "manualCreditCount": 0,
  • "sumOfUpSellByCash": "string",
  • "countOfUpSellByCash": 0,
  • "sumOfUpSellByCashCredits": "string",
  • "sumOfUpSellByCredit": "string",
  • "countOfUpSellByCredit": 0,
  • "sumOfUpSellByCreditCredits": "string",
  • "sumOfCCCharges": "string",
  • "locId": "string",
  • "reportEmpType": "string",
  • "noCollectionMessage": "string",
  • "sumRedemptionTransactions": 0.1,
  • "countRedemptionTransactions": 0,
  • "mobileMechRevenue": [ ],
  • "mobileMechGamePlay": null,
  • "partnerTransactions": [ ]
}

Export a collection by ID

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

collectionId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the collection.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

documentType
string
Enum: "pdf" "excel"

The type of document to export (pdf or excel).

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    }
}

Redemption

Get the current redemption inventory for a location

Retrieves the current redemption inventory for the specified location.

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

skip
integer
Example: skip=10

The number of records to skip in the response. If not specified, no records are skipped.

top
integer
Example: top=10

The maximum number of records to return in the response. If not specified, all records are returned.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 123,
  • "items": [
    ]
}

Reconcile the redemption inventory for a location

Reconciles the redemption inventory for the specified location. This operation updates the inventory counts based on a physical count.

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the location.

query Parameters
apiVersion
string
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
Array of objects

The list of inventory items to reconcile.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    }
}