> For the complete documentation index, see [llms.txt](https://vauchar.gitbook.io/vauchar/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vauchar.gitbook.io/vauchar/api-references/gift-cards/models.md). # Models ## The NewGiftCardRequest object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"NewGiftCardRequest":{"type":"object","required":["value","currency"],"properties":{"start_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card becomes valid."},"expiry_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card expires. Use 0 for no expiration."},"active_status":{"type":"string","description":"The desired status of the gift card upon creation.","enum":["0","1"]},"value":{"type":"string","description":"The monetary value of the gift card."},"currency":{"type":"string","description":"The currency of the gift card's value (e.g., \"USD\")."},"tag":{"type":"string","description":"A tag for organizing or categorizing the gift card."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The UpdateGiftCardRequest object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"UpdateGiftCardRequest":{"type":"object","properties":{"active_status":{"type":"string","description":"The desired status of the gift card.","enum":["0","1"]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The NewRedemptionRequest object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"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."}}}}}} ``` ## The GiftCardList object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"GiftCardList":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The URL of the requested resource collection."},"data":{"type":"array","description":"A list of gift card objects.","items":{"$ref":"#/components/schemas/GiftCard"}}}},"GiftCard":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The unique URL for this specific gift card resource."},"type":{"type":"string","description":"The type of object, in this case, \"gift-card\"."},"id":{"type":"string","description":"The unique identifier for the gift card."},"gift_card_code":{"type":"string","description":"The code of the gift card used for redemption."},"tag":{"type":"string","description":"A tag for organizing or categorizing the gift card."},"created":{"type":"integer","format":"int64","description":"A Unix timestamp representing when the gift card was created."},"start_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card becomes valid."},"expiry_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card expires. A value of 0 indicates no expiration."},"total_value":{"type":"string","description":"The initial value of the gift card."},"balance":{"type":"string","description":"The remaining balance on the gift card."},"value_unit":{"type":"string","description":"The unit of value (e.g., \"value\" for monetary amount)."},"currency":{"type":"string","description":"The currency of the gift card's value (e.g., \"USD\")."},"active_status":{"type":"string","description":"The status of the gift card (e.g., \"1\" for active)."},"brand_id":{"type":"string","description":"The identifier for the brand associated with the gift card (if any)."},"teams":{"type":"array","items":{"type":"string"},"description":"A list of teams associated with the gift card."},"brands":{"type":"array","items":{},"description":"A list of brands associated with the gift card."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The GiftCardResponse object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"GiftCardResponse":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The URL of the requested resource."},"data":{"$ref":"#/components/schemas/GiftCard"}}},"GiftCard":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The unique URL for this specific gift card resource."},"type":{"type":"string","description":"The type of object, in this case, \"gift-card\"."},"id":{"type":"string","description":"The unique identifier for the gift card."},"gift_card_code":{"type":"string","description":"The code of the gift card used for redemption."},"tag":{"type":"string","description":"A tag for organizing or categorizing the gift card."},"created":{"type":"integer","format":"int64","description":"A Unix timestamp representing when the gift card was created."},"start_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card becomes valid."},"expiry_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card expires. A value of 0 indicates no expiration."},"total_value":{"type":"string","description":"The initial value of the gift card."},"balance":{"type":"string","description":"The remaining balance on the gift card."},"value_unit":{"type":"string","description":"The unit of value (e.g., \"value\" for monetary amount)."},"currency":{"type":"string","description":"The currency of the gift card's value (e.g., \"USD\")."},"active_status":{"type":"string","description":"The status of the gift card (e.g., \"1\" for active)."},"brand_id":{"type":"string","description":"The identifier for the brand associated with the gift card (if any)."},"teams":{"type":"array","items":{"type":"string"},"description":"A list of teams associated with the gift card."},"brands":{"type":"array","items":{},"description":"A list of brands associated with the gift card."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The ValidationResponse object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"ValidationResponse":{"type":"object","properties":{"validation_status":{"$ref":"#/components/schemas/ValidationStatus"},"data":{"$ref":"#/components/schemas/GiftCard"}}},"ValidationStatus":{"type":"object","properties":{"status":{"type":"integer","description":"A status code indicating the result of the validation."},"message":{"type":"string","description":"A human-readable message describing the validation result."}}},"GiftCard":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The unique URL for this specific gift card resource."},"type":{"type":"string","description":"The type of object, in this case, \"gift-card\"."},"id":{"type":"string","description":"The unique identifier for the gift card."},"gift_card_code":{"type":"string","description":"The code of the gift card used for redemption."},"tag":{"type":"string","description":"A tag for organizing or categorizing the gift card."},"created":{"type":"integer","format":"int64","description":"A Unix timestamp representing when the gift card was created."},"start_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card becomes valid."},"expiry_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card expires. A value of 0 indicates no expiration."},"total_value":{"type":"string","description":"The initial value of the gift card."},"balance":{"type":"string","description":"The remaining balance on the gift card."},"value_unit":{"type":"string","description":"The unit of value (e.g., \"value\" for monetary amount)."},"currency":{"type":"string","description":"The currency of the gift card's value (e.g., \"USD\")."},"active_status":{"type":"string","description":"The status of the gift card (e.g., \"1\" for active)."},"brand_id":{"type":"string","description":"The identifier for the brand associated with the gift card (if any)."},"teams":{"type":"array","items":{"type":"string"},"description":"A list of teams associated with the gift card."},"brands":{"type":"array","items":{},"description":"A list of brands associated with the gift card."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The RedemptionListResponse object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"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"}}}}}} ``` ## The SingleRedemptionResponse object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"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"}}}}}} ``` ## The ValidationStatus object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"ValidationStatus":{"type":"object","properties":{"status":{"type":"integer","description":"A status code indicating the result of the validation."},"message":{"type":"string","description":"A human-readable message describing the validation result."}}}}}} ``` ## The Redemption object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The GiftCard object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"GiftCard":{"type":"object","properties":{"href":{"type":"string","format":"uri","description":"The unique URL for this specific gift card resource."},"type":{"type":"string","description":"The type of object, in this case, \"gift-card\"."},"id":{"type":"string","description":"The unique identifier for the gift card."},"gift_card_code":{"type":"string","description":"The code of the gift card used for redemption."},"tag":{"type":"string","description":"A tag for organizing or categorizing the gift card."},"created":{"type":"integer","format":"int64","description":"A Unix timestamp representing when the gift card was created."},"start_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card becomes valid."},"expiry_time":{"type":"integer","format":"int64","description":"A Unix timestamp for when the gift card expires. A value of 0 indicates no expiration."},"total_value":{"type":"string","description":"The initial value of the gift card."},"balance":{"type":"string","description":"The remaining balance on the gift card."},"value_unit":{"type":"string","description":"The unit of value (e.g., \"value\" for monetary amount)."},"currency":{"type":"string","description":"The currency of the gift card's value (e.g., \"USD\")."},"active_status":{"type":"string","description":"The status of the gift card (e.g., \"1\" for active)."},"brand_id":{"type":"string","description":"The identifier for the brand associated with the gift card (if any)."},"teams":{"type":"array","items":{"type":"string"},"description":"A list of teams associated with the gift card."},"brands":{"type":"array","items":{},"description":"A list of brands associated with the gift card."},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The Metadata object ```json {"openapi":"3.0.0","info":{"title":"Vauchar Gift Cards API","version":"2.0.0"},"components":{"schemas":{"Metadata":{"type":"object","description":"A set of key-value pairs that you can attach to an object.","properties":{"from_name":{"type":"string"},"from_email":{"type":"string","format":"email"},"to_name":{"type":"string"},"to_email":{"type":"string","format":"email"},"to_phone":{"type":"string"},"message":{"type":"string"}}}}}} ```