VTEX · Schema

GetPaymenttransaction

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
status	string	Transaction status.
isActive	boolean	If it is an active transaction (`true`) or not (`false`).
transactionId	string	Transaction ID.
merchantName	string	Transaction merchant's name.
payments	array	Payments' details object.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPaymenttransaction",
  "title": "GetPaymenttransaction",
  "required": [
    "status",
    "isActive",
    "transactionId",
    "merchantName",
    "payments"
  ],
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Transaction status."
    },
    "isActive": {
      "type": "boolean",
      "description": "If it is an active transaction (`true`) or not (`false`)."
    },
    "transactionId": {
      "type": "string",
      "description": "Transaction ID."
    },
    "merchantName": {
      "type": "string",
      "description": "Transaction merchant's name."
    },
    "payments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Payment1"
      },
      "description": "Payments' details object."
    }
  },
  "example": {
    "status": "Finished",
    "isActive": true,
    "transactionId": "CB452D77E7D04099A4DB0479087B1D2C",
    "merchantName": "LUXSTORE",
    "payments": [
      {
        "id": "721CBE1090324D12ABE301FE33DE775A",
        "paymentSystem": "4",
        "paymentSystemName": "Mastercard",
        "value": 10150,
        "installments": 1,
        "referenceValue": 10150,
        "cardHolder": null,
        "cardNumber": null,
        "firstDigits": "412341",
        "lastDigits": "4123",
        "cvv2": null,
        "expireMonth": null,
        "expireYear": null,
        "url": null,
        "giftCardId": null,
        "giftCardName": null,
        "giftCardCaption": null,
        "redemptionCode": null,
        "group": "creditCard",
        "tid": "101770752",
        "dueDate": null,
        "connectorResponses": {
          "Tid": "101770752",
          "ReturnCode": "200",
          "Message": "logMessage",
          "authId": "170852"
        }
      }
    ]
  }
}