v2
latestOpenAPI 3.1.02026-08-01244220427.0 KBGift Cards
Checkgiftcardbalance
Authenticate the provided card number and security code, and return the card's balance and usability information.
Performs a constant-time security-code comparison and abuse/lockout checks before returning card details.
Returns: BalanceCheckResponse: Contains cardNumber, lastFourDigits, balance, status, expiresAt, and isActive. On authentication failure or lockout the endpoint responds with an HTTP error (e.g., 404 for not found/invalid code, 429 for rate limiting or card lockout).
post/v2/giftcards/programs/{programId}/balance-check
Path parameters
programIdstring required
Example:5eb7cf5a86d9755df3a6c593
Query parameters
cardIdstring
Example:5eb7cf5a86d9755df3a6c593
Headers
X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable
Request body
Response
Successful Response
Example response
{
"id": "5eb7cf5a86d9755df3a6c593",
"programId": "5eb7cf5a86d9755df3a6c593"
}