Sign in

Search giftcards (VTEX callback)

POST /mdw/vtex/giftcards/_search

VTEX calls this when the customer reaches the checkout payment step. Guper looks up the customer by userEmail and/or userProfileId, computes their available cashback balance and returns one virtual giftcard per available wallet. Called by VTEX checkout, not by orgs.

Try-it values populated from environment ACME (Demo)


Request body

Content-Type: application/json

{
    "userEmail": "cliente@example.com",                         // optional
    "userProfileId": "profile-uuid"                             // optional
}

Responses

[
    {
        "id": "cashback-wallet-1",
        "redemptionCode": "...",
        "value": 5000,
        "balance": 5000,
        "caption": "Cashback",
        "profileId": "profile-uuid",
        "groupName": "loyalty",
        "provider": "giftcard-provider-guper"
    }
]
Copied to clipboard