Authentication3

Browsing2

Completed Order Assets4

Completed Orders18

Completion2

Credentials3

Dining2

Discounts3

Events2

Films7

Gift Cards2

post/ocapi/v1/gift-cards/detailsGets the details of a gift card (available balance and expiry date)
post/ocapi/v1/orders/{orderId}/payments/gift-cardsAdds an order gift card payment to an in progress order base

Gift shop1

Items8

Journeys2

Loyalty4

Members20

Orders17

Password Reset3

Payments10

Refunds1

Seating5

Showtimes7

Sites3

Subscriptions10

Third Party Passes1

Third-Party Member Schemes1

Ticket Prices1

Ticket Redemption Cards2

Tips1

Tracking Events2

Watched Films1

Watchlist Films3

Gift Cards

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

Introduced

5.0.5.1

Licenses Required

Vista.Ocapi

post/ocapi/v1/gift-cards/details

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/gift-cards/details/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Connect-Region-Codestring

Region Code

Request body

cardNumberstring required

Gets the card number

pinstring nullable

Gets the PIN

Response

Validation succeeded

maskedCardNumberstring required

Gets a masked representation of the card number

expiresAtstring date-time nullable

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

availableBalancenumber double required

Gets the available balance

Example response

{
  "maskedCardNumber": "12.......6789"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.