Skip to content

Vista Digital Platform (V1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

Discounts

Operations

Events

Operations

Showtimes

Operations

Films

Operations

Gift Cards

Operations

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

Validates whether an email is available for a new member

Request

This endpoint validates email correctly only if the ForceUniqueEmails system setting in Loyalty is set to true.

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

Body
required

Details to validate email availability

emailstring or null

Gets the email address

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/email-availability \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string"
  }'

Responses

Success

Bodyapplication/json
isAvailableboolean

Gets a value indicating whether the provided email is available

Response
application/json
{
  "isAvailable": true
}

Gets the order maximum member balance payment for an in progress order base

Request

The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base that the payment is for

Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/maximum-member-balance' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
paymentobject(OrderMaximumMemberBalancePayment)required

Gets the order maximum member balance payment entity

payment.​balanceTypeIdinteger(int32)required

Gets the unique identifier of the balance type

payment.​maximumValuenumber(double)required

Gets the maximum eligible monetary value

payment.​maximumUnitsnumber(double)required

Gets the maximum eligible value in balance type units

payment.​availableUnitsnumber(double)required

Gets the total available member balance units, including those not eligible to be used as payment for the in progress order base

relatedDataobject(OrderMaximumMemberBalancePaymentRelatedData)required

Gets the related data for the order maximum member balance payment entity

relatedData.​balanceTypeobject(BalanceType)required

Gets the related balance type entity

relatedData.​balanceType.​idinteger(int32)required

Gets the unique identifier

relatedData.​balanceType.​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​balanceType.​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​balanceType.​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​balanceType.​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​balanceType.​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​balanceType.​isPrimarybooleanrequired

Gets a value indicating whether this is the primary balance type

relatedData.​balanceType.​unitNamestring or null

Gets the name of the balance units

Example: "Points"
relatedData.​balanceType.​paymentConversionRatenumber or null(double)

Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable

relatedData.​balanceType.​unitDecimalPlacesinteger(int32)required

Gets the number of decimal places used to format and calculate balance unit values

Response
application/json
{
  "payment": {
    "balanceTypeId": 0,
    "maximumValue": 0.1,
    "maximumUnits": 0.1,
    "availableUnits": 0.1
  },
  "relatedData": {
    "balanceType": { … }
  }
}

Sets the order member balance payment for an in progress order base

Request

The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base that the payment is for

Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Body
required

The member balance payment request

valuenumber or null(double)

Gets the monetary value, if applicable

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/member-balance' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "value": 0.1
  }'

Responses

Success

Bodyapplication/json
idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the payment within the order base

typestring(OrderPaymentType)required

Gets the type

Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"
valuenumber(double)required

Gets the monetary value

statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"
balanceTypeIdinteger(int32)required

Gets the unique identifier of the balance type

unitsnumber(double)required

Gets the value in balance type units

Response
application/json
{
  "id": "string",
  "type": "CinemaProcessed",
  "value": 0.1,
  "status": "NotStarted",
  "balanceTypeId": 0,
  "units": 0.1
}

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Member Rewards

Operations

Subscriptions

Operations

Ticket Redemption Cards

Operations

Credentials

Operations

Watched Films

Operations

Watchlist Films

Operations

Completion

Operations

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations