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

Gets the details of a gift card (available balance and expiry date)

Request

Introduced

5.0.5.1

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

Body
required

Credentials of the requested gift card

cardNumberstringnon-emptyrequired

Gets the card number

pinstring or null

Gets the PIN

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/gift-cards/details \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "cardNumber": "string",
    "pin": "string"
  }'

Responses

Validation succeeded

Bodyapplication/json
maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"
expiresAtstring or null(date-time)

Gets the expiry date and time, or null if the gift card never expires

availableBalancenumber(double)required

Gets the available balance

Response
application/json
{
  "maskedCardNumber": "12.......6789",
  "expiresAt": "2019-08-24T14:15:22Z",
  "availableBalance": 0.1
}

Adds a gift card payment to the order

Request

Payment details are stored against order and processed when order is complete.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base that the payment will be added to

Headers
Connect-Region-Codestring

Region Code

Body
required

The gift card payment request

cardNumberstringnon-emptyrequired

Gets the card number

pinstring or null

Gets the PIN

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/gift-cards' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "cardNumber": "string",
    "pin": "string"
  }'

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"
maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"
valuenumber(double)required

Gets the monetary value

statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"
Response
application/json
{
  "id": "string",
  "type": "CinemaProcessed",
  "maskedCardNumber": "12.......6789",
  "value": 0.1,
  "status": "NotStarted"
}

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

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