VTEX · Schema

PaymentData

Object with information about the payment.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
giftCards array Array with information about Gift Cards.
transactions array Information about financial transactions.
View JSON Schema on GitHub

JSON Schema

vtex-paymentdata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentData",
  "title": "PaymentData",
  "description": "Object with information about the payment.",
  "required": [
    "transactions"
  ],
  "type": "object",
  "properties": {
    "giftCards": {
      "type": "array",
      "description": "Array with information about Gift Cards.",
      "items": {
        "type": "string"
      }
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Transaction"
      },
      "description": "Information about financial transactions."
    }
  },
  "example": {
    "giftCards": [],
    "transactions": [
      {
        "isActive": true,
        "transactionId": "418213DE29634837A63DD693A937A696",
        "merchantName": "luxstore",
        "payments": [
          {
            "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
            "paymentSystem": "6",
            "paymentSystemName": "Boleto Banc\u00e1rio",
            "value": 4450,
            "installments": 1,
            "referenceValue": 4450,
            "cardHolder": null,
            "cardNumber": null,
            "firstDigits": null,
            "lastDigits": null,
            "cvv2": null,
            "expireMonth": null,
            "expireYear": null,
            "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
            "giftCardId": null,
            "giftCardName": null,
            "giftCardCaption": null,
            "redemptionCode": null,
            "group": "bankInvoice",
            "tid": null,
            "dueDate": "2019-02-02",
            "connectorResponses": {
              "Tid": "94857956",
              "ReturnCode": "200",
              "Message": "logMessage",
              "authId": "857956"
            },
            "giftCardProvider": "presentCard",
            "giftCardAsDiscount": false,
            "koinUrl": "koinURL",
            "accountId": "5BC5C6B417FE432AB971B1D399F190C9",
            "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
            "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
            "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
            "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
            "bankIssuedInvoiceBarCodeType": "i25",
            "billingAddress": {}
          }
        ]
      }
    ]
  }
}