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

Introduced

5.0.5.1

Licenses Required

  • Vista.Ocapi
Request
header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

Credentials of the requested gift card

cardNumber
required
string non-empty

Gets the card number

pin
string or null

Gets the PIN

Responses
200

Validation succeeded

400

The provided gift card credentials are invalid.

429

Too many requests. Try again later.

post/ocapi/v1/gift-cards/details
Request samples
{
  • "cardNumber": "string",
  • "pin": "string"
}
Response samples
application/json
{
  • "maskedCardNumber": "12.......6789",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "availableBalance": 0.1
}