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

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Gets the list of member payment card entities for the currently authenticated member

Request

Licenses Required

  • Vista.Ocapi
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/members/current/payment-cards \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
cardsArray of objects(MemberPaymentCard)required

Gets the list of member payment card entities

cards[].​idstringnon-emptyrequired

Gets the unique identifier

cards[].​cardDetailsobject(PaymentCardDetails)required

Gets the card details

cards[].​cardDetails.​maskedCardNumberstringnon-emptyrequired

Gets the masked card number

Example: "411111......1111"
cards[].​cardDetails.​typestring or null

Gets the card type

Example: "VISA"
cards[].​cardDetails.​expiryMonthinteger or null(int32)

Gets the card expiry month

Example: 1
cards[].​cardDetails.​expiryYearinteger or null(int32)

Gets the card expiry year

Example: 27
cards[].​isPrimarybooleanrequired

Gets a value indicating whether this is the primary card

cards[].​isUsedForRecurringSubscriptionBillingbooleanrequired

Gets a value indicating whether this card is used for automatic payments for a recurring member subscription

Response
application/json
{
  "cards": [
    { … }
  ]
}

Gets a member payment card for the currently authenticated member by its unique identifier

Request

Licenses Required

  • Vista.Ocapi
Path
memberPaymentCardIdstringrequired

The member payment card identifier

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/members/current/payment-cards/{memberPaymentCardId}' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
idstringnon-emptyrequired

Gets the unique identifier

cardDetailsobject(PaymentCardDetails)required

Gets the card details

cardDetails.​maskedCardNumberstringnon-emptyrequired

Gets the masked card number

Example: "411111......1111"
cardDetails.​typestring or null

Gets the card type

Example: "VISA"
cardDetails.​expiryMonthinteger or null(int32)

Gets the card expiry month

Example: 1
cardDetails.​expiryYearinteger or null(int32)

Gets the card expiry year

Example: 27
isPrimarybooleanrequired

Gets a value indicating whether this is the primary card

isUsedForRecurringSubscriptionBillingbooleanrequired

Gets a value indicating whether this card is used for automatic payments for a recurring member subscription

Response
application/json
{
  "id": "string",
  "cardDetails": {
    "maskedCardNumber": "411111......1111",
    "type": "VISA",
    "expiryMonth": 1,
    "expiryYear": 27
  },
  "isPrimary": true,
  "isUsedForRecurringSubscriptionBilling": true
}

Removes a member payment card for the currently authenticated member

Request

Licenses Required

  • Vista.Ocapi
Path
memberPaymentCardIdstringrequired

The member payment card identifier

Headers
loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

curl -i -X DELETE \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Member payment card removed.

Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member

Request

Licenses Required

  • Vista.Ocapi
Headers
loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body
required

The values needed to create an embedded member payment card

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring or null(uri)

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTagstring or null

Gets the IETF (RFC 4646) language tag

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/payment-cards/embedded \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string"
  }'

Responses

Success

Bodyapplication/json
memberPaymentCardIdstringnon-emptyrequired

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

connectorFunctionNamestringnon-emptyrequired

Gets the name of the connector function that needs to be called

connectorParametersJsonstringnon-emptyrequired

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring(uri)required

Gets the create card token URL

sdkScriptUrlsArray of stringsrequired

Gets the list of SDK script URLs that need to be loaded

isButtonIncludedbooleanrequired

Gets a value indicating whether the payment connector UI includes a submit button

isPrimaryCardOptionIncludedbooleanrequired

Gets a value indicating whether the primary card option is included

connectorScriptUrlsArray of stringsrequired

Gets the list of connector script URLs that need to be loaded

Response
application/json
{
  "memberPaymentCardId": "string",
  "webPaymentMethodId": 0,
  "connectorFunctionName": "string",
  "connectorParametersJson": "string",
  "createCardTokenUrl": "http://example.com",
  "sdkScriptUrls": [
    "string"
  ],
  "isButtonIncluded": true,
  "isPrimaryCardOptionIncluded": true,
  "connectorScriptUrls": [
    "string"
  ]
}

Removes an order payment base from an in progress order base

Request

Only order gift card payment and order member balance payment entities can be removed at this time.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base that the payment will be removed from

paymentIdstringrequired

The unique identifier of the order payment base to be removed

Headers
Connect-Region-Codestring

Region Code

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

Responses

Payment removed.

Creates a order embedded payment

Request

Initiates an order embedded payment with the connector so that the client can render a UI based on the returned order embedded payment client data

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Path
orderIdstringrequired

The unique identifier of the current in progress order base for which the payment is starting

Headers
Connect-Region-Codestring

Region Code

Body
required

Values needed to start the embedded payment

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring or null(uri)

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTagstring or null

Gets the IETF (RFC 4646) language tag

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/embedded' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string"
  }'

Responses

Success

Bodyapplication/json
embeddedPaymentobject(OrderEmbeddedPayment)required

Gets the order embedded payment entity

embeddedPayment.​idstringnon-emptyrequired

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

embeddedPayment.​typestring(OrderPaymentType)required

Gets the type

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

Gets the monetary value

embeddedPayment.​statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"
clientDataobject(OrderEmbeddedPaymentClientData)required

Gets the order embedded payment client data entity

clientData.​connectorParametersJsonstringnon-emptyrequired

Gets the JSON blob of parameters required by the connector

clientData.​completePaymentUrlstring(uri)required

Gets the URL that needs to be called after the payment has been accepted

clientData.​sdkScriptUrlsArray of stringsrequired

Gets the list of SDK script URLs that need to be loaded

clientData.​connectorScriptUrlsArray of stringsrequired

Gets the list of connector script URLs that need to be loaded

clientData.​connectorFunctionNamestringnon-emptyrequired

Gets the name of the connector function that needs to be called

clientData.​isPaymentButtonIncludedbooleanrequired

Gets a value indicating whether or not the payment connector UI includes a payment button

updatedOrderExpiresAtstring(date-time)required

Gets the updated date and time that the in progress order base expires

Response
application/json
{
  "embeddedPayment": {
    "id": "string",
    "type": "CinemaProcessed",
    "value": 0.1,
    "status": "NotStarted"
  },
  "clientData": {
    "connectorParametersJson": "string",
    "completePaymentUrl": "http://example.com",
    "sdkScriptUrls": [ … ],
    "connectorScriptUrls": [ … ],
    "connectorFunctionName": "string",
    "isPaymentButtonIncluded": true
  },
  "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}

Gets the current order embedded payment for the order

Request

The payment considered current is the most recently created order embedded payment for the order.

This endpoint may be polled to determine the status of the payment after embedded payment process has completed on client. This is required currently due to limitations in the current Web Payment Module payment process around returning payment status as part of the UI interaction requiring the client to make this extra call before leaving the payment UI.

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Path
orderIdstringrequired

The unique identifier of the in progress order base

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/embedded/current' \
  -H 'Connect-Region-Code: 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"
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",
  "value": 0.1,
  "status": "NotStarted"
}

Creates an order redirect payment

Request

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

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

Headers
Connect-Region-Codestring

Region Code

Body
required

Values needed to start the redirect payment

webPaymentMethodIdinteger(int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring(uri)required

Gets the URL that the browser will be directed to after the after successful or cancelled payment

languageTagstring or null

Gets the IETF (RFC 4646) language tag

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/redirect' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string"
  }'

Responses

Success

Bodyapplication/json
redirectPaymentobject(OrderRedirectPayment)required

Gets the order redirect payment entity

redirectPayment.​idstringnon-emptyrequired

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

redirectPayment.​typestring(OrderPaymentType)required

Gets the type

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

Gets the monetary value

redirectPayment.​statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"
redirectUrlstring(uri)required

Gets the URL of the payment page

updatedOrderExpiresAtstring(date-time)required

Gets the updated date and time that the in progress order base expires

Response
application/json
{
  "redirectPayment": {
    "id": "string",
    "type": "CinemaProcessed",
    "value": 0.1,
    "status": "NotStarted"
  },
  "redirectUrl": "http://example.com",
  "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}

Gets the current order redirect payment for the order

Request

The payment considered current is the most recently created order redirect payment for the order.

This endpoint may be polled to determine the status of the payment after the redirect payment process has completed on the client. This is required currently due to limitations in the current Web Payment Module payment process around returning payment status as part of the UI interaction requiring the client to make this extra call before leaving the payment UI.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/redirect/current' \
  -H 'Connect-Region-Code: 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"
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",
  "value": 0.1,
  "status": "NotStarted"
}

Gets the web payment method options for an in progress order base, based on the provided order type

Request

Licenses Required

  • Vista.Ocapi
Query
orderTypestring(OrderType)required

The type of the in progress order base that the web payment method entities are available for

Enum"Standard""GiftShop""Subscription"
siteIdstring

The unique identifier of the site Only valid for order type Standard

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/web-payment-methods?orderType=Standard&siteId=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
webPaymentMethodsArray of objects(WebPaymentMethod)required

Gets the list of web payment method entities

webPaymentMethods[].​typestring(WebPaymentMethodType)required

Gets the type

Enum"Redirect""Embedded"
webPaymentMethods[].​isDefaultbooleanrequired

Gets a value indicating whether this is the default web payment method

webPaymentMethods[].​idinteger(int32)required

Gets the unique identifier

webPaymentMethods[].​nameobject(Translatable)required

Gets the name text, and its translations

webPaymentMethods[].​name.​textstringnon-emptyrequired

Gets the text in the default language

webPaymentMethods[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

webPaymentMethods[].​name.​translations[].​languageTagstringnon-emptyrequired

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

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

Gets the translated text

webPaymentMethods[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

webPaymentMethods[].​isRecurringBillingSupportedbooleanrequired

Gets a value indicating whether recurring billing is supported

Response
application/json
{
  "webPaymentMethods": [
    { … }
  ]
}

Set the primary member payment card for the currently authenticated member
Deprecated

Request

Licenses Required

  • Vista.Ocapi
Headers
loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body
required

The values needed to update the member's primary member payment card

memberPaymentCardIdstringnon-emptyrequired

Gets the unique identifier of the member payment card

curl -i -X PUT \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/payment-cards/primary \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "memberPaymentCardId": "string"
  }'

Responses

Member primary payment card updated.

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