Gift Cards Public API
string · requiredstring · required
Look up a gift card and retrieve its details and balance.
Get card details
POST
https://api.poswithlogic.dev
/giftcard/api/cards/get
Headers
x-zpl-api-keyGateway API key. Required on every request.
x-api-keyYour store API key — authenticates the request as your store.
Get card details › Request Body
Request model containing only a card number for operations that require card number identification.
cardNumberGets or sets the card number. This field is required.
Get card details › Responses
OK
Represents a response data object containing a result or error information.
object
Data transfer object representing a gift card.
isOkGets or sets a value indicating whether the operation was successful.
errorMessageGets or sets the error message if the operation failed.
errorCodeGets or sets a stable, machine-readable error code when the operation failed with a
known business error (e.g. "Incorrect" / "Locked" for PIN checkout).
Clients should switch on this instead of parsing ErrorMessage. Null for
success and for generic/unclassified failures.