Gift Cards
Create Gift Card
This endpoint adds a new gift card to a user’s account.
POST
This endpoint allows users to add a gift card to their account. The card is validated with the gift card provider and the balance is checked before the card is stored. The system prevents duplicate cards — the same card number cannot be added twice for the same user and merchant.
Please review proper request headers here.
Body
The provider merchant ID. This identifies which gift card provider and merchant configuration to use for validation.
The full gift card number
The PIN code for the gift card, if required by the provider
Response
Gift card ID
Provider merchant ID
Full gift card number
PIN code (if required by provider)
Last 4 digits of the card number
Current balance on the gift card (fetched in real-time from provider)
Gift card state (
active, archived)Expiration date in ISO8601 format (nullable)
Time the gift card was added in ISO8601 format