VTEX · Schema

CreateGiftCardTransactionRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
operation string Type of operation. Possible values are: `Debit` or `Credit`.
value number Operation value.
description string Description information.
redemptionToken string Gift card redemption token.
redemptionCode string Gift card identification code used at checkout. Minimum of 6 characters.
requestId string Request identification of the transaction. You need to send a different `requestId` value every time you make a new transaction. If you send the same `requestId`two or more times with a specific `rede
orderInfo object
View JSON Schema on GitHub

JSON Schema

vtex-creategiftcardtransactionrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateGiftCardTransactionRequest",
  "title": "CreateGiftCardTransactionRequest",
  "required": [
    "operation",
    "value",
    "description",
    "redemptionToken",
    "redemptionCode",
    "requestId",
    "orderInfo"
  ],
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "description": "Type of operation. Possible values are: `Debit` or `Credit`.",
      "example": "Debit"
    },
    "value": {
      "type": "number",
      "format": "decimal",
      "description": "Operation value.",
      "example": 3
    },
    "description": {
      "type": "string",
      "description": "Description information.",
      "example": "GiftCardHub"
    },
    "redemptionToken": {
      "type": "string",
      "description": "Gift card redemption token.",
      "example": "b2dac6f2-f365-48cd-82a9-0b376a55557a"
    },
    "redemptionCode": {
      "type": "string",
      "description": "Gift card identification code used at checkout. Minimum of 6 characters.",
      "example": "***********ASDQ"
    },
    "requestId": {
      "type": "string",
      "description": "Request identification of the transaction. You need to send a different `requestId` value every time you make a new transaction. If you send the same `requestId`two or more times with a specific `redemptionCode`or `redemptionToken`, the gift card balance will not be updated.",
      "example": "B56CBE231DEE4E1A859183C1030CE926"
    },
    "orderInfo": {
      "$ref": "#/components/schemas/OrderInfo"
    }
  }
}