Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
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

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"
}