# Gift Card Redemptions Operations related to gift card redemptions. ## List Gift Card Redemptions > Retrieves the redemption history for a specific gift card. ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"tags":[{"name":"Gift Card Redemptions","description":"Operations related to gift card redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic Authentication requires a Base64 encoded string of your `:`."}},"schemas":{"RedemptionListResponse":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Redemption"}}}},"Redemption":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"id":{"type":"string"},"gift_card_id":{"type":"string"},"user_id":{"type":"string"},"user_email":{"type":"string","format":"email"},"user_phone":{"type":"string"},"transaction_id":{"type":"string"},"value_used":{"type":"string"},"created":{"type":"integer","format":"int64"}}}}},"paths":{"/gift-cards/{gift_card_id}/redemptions":{"get":{"summary":"List Gift Card Redemptions","description":"Retrieves the redemption history for a specific gift card.","tags":["Gift Card Redemptions"],"parameters":[{"name":"gift_card_id","in":"path","required":true,"description":"The unique identifier of the gift card.","schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response with the gift card's redemption history.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedemptionListResponse"}}}},"401":{"description":"Unauthorized. The request lacks valid authentication credentials."},"404":{"description":"Not Found. A gift card with the specified ID does not exist."}}}}}} ``` ## Create a Gift Card Redemption > Redeems a specific gift card by its ID. ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"tags":[{"name":"Gift Card Redemptions","description":"Operations related to gift card redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic Authentication requires a Base64 encoded string of your `:`."}},"schemas":{"NewRedemptionRequest":{"type":"object","required":["value_used"],"properties":{"user_id":{"type":"string"},"user_email":{"type":"string","format":"email"},"user_phone":{"type":"string"},"value_used":{"type":"number","description":"The amount of value to be used from the gift card."}}},"Redemption":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"id":{"type":"string"},"gift_card_id":{"type":"string"},"user_id":{"type":"string"},"user_email":{"type":"string","format":"email"},"user_phone":{"type":"string"},"transaction_id":{"type":"string"},"value_used":{"type":"string"},"created":{"type":"integer","format":"int64"}}}}},"paths":{"/gift-cards/{gift_card_id}/redemptions":{"post":{"summary":"Create a Gift Card Redemption","description":"Redeems a specific gift card by its ID.","tags":["Gift Card Redemptions"],"parameters":[{"name":"gift_card_id","in":"path","required":true,"description":"The unique identifier of the gift card to redeem.","schema":{"type":"string"}}],"requestBody":{"description":"Details for the redemption.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRedemptionRequest"}}}},"responses":{"201":{"description":"Redemption created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redemption"}}}},"400":{"description":"Bad Request. The request body is invalid or the gift card cannot be redeemed."},"401":{"description":"Unauthorized. The request lacks valid authentication credentials."},"404":{"description":"Not Found. A gift card with the specified ID does not exist."}}}}}} ``` ## Retrieve a specific Redemption > Retrieves the details of a single gift card redemption. ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"tags":[{"name":"Gift Card Redemptions","description":"Operations related to gift card redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic Authentication requires a Base64 encoded string of your `:`."}},"schemas":{"SingleRedemptionResponse":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"data":{"$ref":"#/components/schemas/Redemption"}}},"Redemption":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"id":{"type":"string"},"gift_card_id":{"type":"string"},"user_id":{"type":"string"},"user_email":{"type":"string","format":"email"},"user_phone":{"type":"string"},"transaction_id":{"type":"string"},"value_used":{"type":"string"},"created":{"type":"integer","format":"int64"}}}}},"paths":{"/gift-cards/{gift_card_id}/redemptions/{redemption_id}":{"get":{"summary":"Retrieve a specific Redemption","description":"Retrieves the details of a single gift card redemption.","tags":["Gift Card Redemptions"],"parameters":[{"name":"gift_card_id","in":"path","required":true,"description":"The unique identifier of the gift card.","schema":{"type":"string"}},{"name":"redemption_id","in":"path","required":true,"description":"The unique identifier of the redemption.","schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response with the redemption details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleRedemptionResponse"}}}},"401":{"description":"Unauthorized. The request lacks valid authentication credentials."},"404":{"description":"Not Found. A redemption with the specified ID does not exist."}}}}}} ``` ## Delete a Redemption > Permanently deletes a specific gift card redemption. ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"tags":[{"name":"Gift Card Redemptions","description":"Operations related to gift card redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic Authentication requires a Base64 encoded string of your `:`."}}},"paths":{"/gift-cards/{gift_card_id}/redemptions/{redemption_id}":{"delete":{"summary":"Delete a Redemption","description":"Permanently deletes a specific gift card redemption.","tags":["Gift Card Redemptions"],"parameters":[{"name":"gift_card_id","in":"path","required":true,"description":"The unique identifier of the gift card.","schema":{"type":"string"}},{"name":"redemption_id","in":"path","required":true,"description":"The unique identifier of the redemption to delete.","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content. The redemption was successfully deleted."},"401":{"description":"Unauthorized. The request lacks valid authentication credentials."},"404":{"description":"Not Found. The specified redemption does not exist."}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://vauchar.gitbook.io/vauchar/api-references/gift-cards/gift-card-redemptions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.