Merchant API Documentation
This API allows merchants to validate and redeem Giftminati Gift Cards at the point of sale. All gift cards must be validated and redeemed for their full value. Partial redemptions are not supported.
Base URL: https://api.giftminati.com/v1
Authentication
All API requests must include an `Authorization` header with your unique API key.
Authorization: Bearer 1. Validate Gift Card
This endpoint allows a merchant to check the status and value of a gift card before a customer makes a purchase.
Endpoint: POST /cards/validate
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| `cardNumber` | String | Yes | The full 16-character alphanumeric gift card number. |
| `amount` | Number | Yes | The transaction amount. This must match the card's full value. |
Success Response (200 OK)
{
"success": true,
"status": "VALID",
"message": "Gift card is valid for redemption.",
"cardValue": 200
}2. Redeem Gift Card
This endpoint is used to redeem a gift card for its full value. This action is final and will update the card's status to "Redeemed".
Endpoint: POST /cards/redeem
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| `cardNumber` | String | Yes | The full 16-character alphanumeric gift card number. |
| `amount` | Number | Yes | The transaction amount. Must match the card's full value. |
| `transactionId` | String | Yes | A unique ID from the merchant's point-of-sale system for this transaction. |
Success Response (200 OK)
{
"success": true,
"status": "REDEEMED",
"message": "Gift card successfully redeemed.",
"transactionId": "GIFTMINATI-TRX-ABC123DEF",
"redeemedAmount": 200
}