---
title: "Gets the details of a gift card (available balance and expiry date)"
method: POST
path: "/ocapi/v1/gift-cards/details"
tags: ["Gift Cards"]
---

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

`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)
- URL: `https://developer.vista.co/ocapi/v1/gift-cards/details`
- 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)

#### Introduced

5.0.5.1

#### Licenses Required


- Vista.Ocapi

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1GiftCardsGiftCardCredentials: Represents the credentials required to validate a gift card
  - `cardNumber` string, required: Gets the card number
  - `pin` string, nullable: Gets the PIN

## Response `200`

Validation succeeded

- OcapiV1GiftCardsGiftCardDetails: Represents the details of a validated gift card
  - `maskedCardNumber` string, required: Gets a masked representation of the card number
  - `expiresAt` string, date-time, nullable: Gets the expiry date and time, or null if the gift card never expires
  - `availableBalance` number, double, required: Gets the available balance

## Other responses

- `400`: The provided gift card credentials are invalid.
- `429`: Too many requests. Try again later.

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)