Gift Card Redeemed

"giftcard.redeemed" event.

The "giftcard.redeemed" event is triggered when a gift card is successfully redeemed by a business, or another 3rd party. This webhook provides details about the redemption.

Payload Structure

JSON

{
    "event": "giftcard.redeemed",
    "data": {
        "giftCard": "string",
        "listingId": "string",
        "amountRedeemed": integer,
        "serialNo": "string",
        "cardType": "string",
        "isActivated": boolean
    },
    "meta": {
        "eventTimestamp": "timestamp",
        "balances": {
            "rewardWallet": integer,
            "mainWallet": integer
        }
    }
}

Example Request

Below is an example of a webhook request for "giftcard.redeemed"

Headers

POST /https://hooks.company.com/endpoint HTTP/1.1
Content-Type: application/json
Content-Length: 315
Signature: c91fbf207eaf3a3bb7bf28ffc5092deef8a1e5d631668e764c429056949d3220

Body / Payload

JSON

{
    "event": "giftcard.redeemed",
    "data": {
        "giftCard": "DSTv Nigeria Gift Card",
        "listingId": "MZ-GC-NKZUVAVF6I",
        "amountRedeemed": 510000,
        "serialNo": "SN6729493A9867B186",
        "cardType": "VIRTUAL",
        "isActivated": true
    },
    "meta": {
        "eventTimestamp": "2025-01-16T09:38:45.433788Z",
        "balances": {
            "rewardWallet": 32000000,
            "mainWallet": 130000
        }
    }
}

🚧

Note!

Numerical currency values in body are usually in smallest unit. i.e, NGN500 will be represented as 50000k.