Gift card identification code used at checkout. Minimum of 6 characters.
balance
number
Gift card current balance. For newly created gift cards, the balance will be 0.0.
relationName
string
Field to be filled in when it is not necessary to use a loyalty program for the gift card. Note that a new `relationNamevalue` is required for each new gift card to be created.
emissionDate
string
Gift card creation date.
expiringDate
string
Gift card expiration date.
caption
string
Field to be filled in if a loyalty program must be created for the Gift Card.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/response",
"title": "response",
"type": "object",
"required": [
"id",
"redemptionToken",
"redemptionCode",
"balance",
"relationName",
"emissionDate",
"expiringDate",
"caption",
"transactions"
],
"properties": {
"id": {
"type": "string",
"description": "Gift card identification.",
"example": "954"
},
"redemptionToken": {
"type": "string",
"description": "Gift card redemption token.",
"example": "32ScL57220Vapb8pc50HJ3mWH1cl1L8x"
},
"redemptionCode": {
"type": "string",
"description": "Gift card identification code used at checkout. Minimum of 6 characters.",
"example": "***********ASDQ"
},
"balance": {
"type": "number",
"description": "Gift card current balance. For newly created gift cards, the balance will be 0.0.",
"example": 0
},
"relationName": {
"type": "string",
"description": "Field to be filled in when it is not necessary to use a loyalty program for the gift card. Note that a new `relationNamevalue` is required for each new gift card to be created.",
"example": "cardName"
},
"emissionDate": {
"type": "string",
"description": "Gift card creation date.",
"example": "2014-04-24T20:22:58.163"
},
"expiringDate": {
"type": "string",
"description": "Gift card expiration date.",
"example": "2016-01-01T00:00:00"
},
"caption": {
"type": "string",
"description": "Field to be filled in if a loyalty program must be created for the Gift Card.",
"example": "VTEX Loyalty Program"
},
"currencyCode": {
"type": "string",
"description": "Currency code in ISO 4217.",
"example": "USD"
},
"transactions": {
"$ref": "#/components/schemas/Transactions"
}
}
}