API docs by Redocly

Card API (1.0.0)

Download OpenAPI specification:

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

API for the Amusement Connect card system.

Location

Location

Get location pricing

Get the card and credit pricing options for location

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

includePackages
boolean

Whether to include the available packages for the location in the response. If not provided, the packages will not be included.

Responses

Response samples

Content type
application/json
{
  • "credits": {
    },
  • "packages": [
    ]
}

Create card transaction

Create a new card transaction at a location Adds a new transaction to for adding to a cards balance at this location.

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

whatIf
boolean

If true, the transaction will be validated but not actually processed. This can be used to check if a transaction request is valid and see the expected outcome without making any changes to the card balances.

Request Body schema: application/json
required
Array of objects or null

A list of credit purchases made in a single transaction. Each entry in the list represents a purchase of credits for a specific card number.

Array of objects or null

A list of package purchases made in a single transaction. Each entry in the list represents a purchase of a specific package for a set of card numbers.

Responses

Request samples

Content type
application/json
{
  • "credits": [
    ],
  • "packages": [
    ]
}

Response samples

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

Refund card transaction

Refund a card transaction by its ID at a location. Reverses the effects of the original transaction, removing any credits, tickets, timed play, or attractions purchased.

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

cardTransactionId
required
string <uuid> (cardTransactionId)
Example: 00000000-0000-0000-0000-000000000000

The unique identifier of the card transaction.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

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

Card

Card

Get tabs at a location

Search and filter tabs at a location

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

take
integer
Example: take=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.

status
any (status)
Enum: "Open" "Closed" "Settled"

Filter tabs by their status.

orderDescending
boolean
Default: false

Reverses the sort order of the results to be in descending order.

orderBy
any
Default: "openedAtUtc"
Enum: "openedAtUtc" "closedAtUtc" "settledAtUtc" "status"

The field to order the results by. Defaults to openedAtUtc.

thenBy
any
Default: "openedAtUtc"
Enum: "openedAtUtc" "closedAtUtc" "settledAtUtc"

An additional field to order the results by after ordering by the orderBy field. Only applies if the orderBy parameter is 'status'.

openFrom
string <date-time>

Filter to tabs that were open on or after this date and time.

openTo
string <date-time>

Filter to tabs that were open on or before this date and time.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Open tab at location

Opens a tab for a player at a location

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
object (Money)
autoCloseAtUtc
string or null <date-time>

The date and time when the tab will automatically close. If null, the tab will remain open until manually closed.

cardNumbers
required
Array of strings (rfid) [ items^\\+?[0-9]{10}$ ]

The list of card numbers to associate with the tab.

Responses

Request samples

Content type
application/json
{
  • "limit": {
    },
  • "autoCloseAtUtc": "2019-08-24T14:15:22Z",
  • "cardNumbers": [
    ]
}

Response samples

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

Get tab by ID at location

Get a tab by its ID at a location

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

tabId
required
string <uuid>
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "openedAtUtc": "2019-08-24T14:15:22Z",
  • "status": "Open",
  • "closedAtUtc": "2019-08-24T14:15:22Z",
  • "settledAtUtc": "2019-08-24T14:15:22Z",
  • "spent": {
    },
  • "limit": {
    },
  • "autoCloseAtUtc": "2019-08-24T14:15:22Z",
  • "cards": [
    ]
}

Close a tab

Close a tab, preventing it from accepting any new charges.

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

tabId
required
string <uuid>
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

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

Settle a tab

Settle a tab, finalizing all charges and payments.

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

tabId
required
string <uuid>
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

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

Get location balance

Get the balance for a card at a specific location

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

cardNumber
required
string (rfid) ^\\+?[0-9]{10}$
Example: 0715468881

The unique identifier of the card.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "credits": 100,
  • "tickets": 5,
  • "timedPlay": {
    },
  • "attractions": [
    ],
  • "location": {
    }
}

Update location balance

Update the location balance for a card to the desired state.

Authorizations:
apiKey
path Parameters
required
integer or string (locationId)

The unique identifier of the location.

cardNumber
required
string (rfid) ^\\+?[0-9]{10}$
Example: 0715468881

The unique identifier of the card.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required
credits
number <double>
tickets
number <double>
object or null
Array of objects or objects or null

Responses

Request samples

Content type
application/json
{
  • "credits": 100,
  • "tickets": 5,
  • "timedPlay": {
    },
  • "attractions": [
    ]
}

Response samples

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

Get card by card number

Get card by card number

Authorizations:
apiKey
path Parameters
cardNumber
required
string (rfid) ^\\+?[0-9]{10}$
Example: 0715468881

The unique identifier of the card.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

cardLife
number

Optional parameter to specify a specific card life to get for the card. If not provided, the latest card life will be returned.

integer or string (locationId)

Optional location ID to filter the balances on the card by location.

Responses

Response samples

Content type
application/json
{
  • "rfid": "0715468881",
  • "cardLife": 1,
  • "player": {
    },
  • "issuance": {
    },
  • "lastUsage": {
    }
}