VTEX · Schema

PaymentDetailsResponse

Payment details information.

CommerceE-CommerceRetailMarketplacePayments
View JSON Schema on GitHub

JSON Schema

vtex-paymentdetailsresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentDetailsResponse",
  "title": "PaymentDetailsResponse",
  "required": [
    "id",
    "paymentSystem",
    "paymentSystemName",
    "merchantName",
    "group",
    "userProfileId",
    "isCustom",
    "allowInstallments",
    "requiresAuthentication",
    "allowIssuer",
    "allowNotification",
    "isAvailable",
    "description",
    "authorizationDate",
    "self",
    "tid",
    "returnCode",
    "returnMessage",
    "status",
    "connector",
    "ConnectorResponses",
    "connectorResponse",
    "ShowConnectorResponses",
    "value",
    "installmentsInterestRate",
    "installmentsValue",
    "referenceValue",
    "installments",
    "currencyCode",
    "provider",
    "isBillingAddressDifferent",
    "isRegexValid",
    "isLuhnValid",
    "fields",
    "sheets",
    "originalPaymentId"
  ],
  "type": "object",
  "description": "Payment details information.",
  "items": {
    "type": "object",
    "description": "Payment details information.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Payment identification."
      },
      "paymentSystem": {
        "type": "number",
        "description": "Payment system identification."
      },
      "paymentSystemName": {
        "type": "string",
        "description": "Payment system name."
      },
      "merchantName": {
        "type": "string",
        "description": "Merchant name.",
        "nullable": true
      },
      "group": {
        "type": "string",
        "description": "Payment group name."
      },
      "userProfileId": {
        "type": "string",
        "description": "Unique ID associated with the customer profile.",
        "nullable": true
      },
      "isCustom": {
        "type": "boolean",
        "description": "Indicates whether it is custom."
      },
      "allowInstallments": {
        "type": "boolean",
        "description": "Indicates whether the payment method allows installments."
      },
      "requiresAuthentication": {
        "type": "boolean",
        "description": "Indicates whether it is necessary to log in to make the payment."
      },
      "allowIssuer": {
        "type": "boolean",
        "description": "Indicates whether it is possible to identify the name of the bank responsible for issuing the card."
      },
      "allowNotification": {
        "type": "boolean",
        "description": "Indicates the possibility of payment notification (used by bank invoices and notes payable)."
      },
      "isAvailable": {
        "type": "boolean",
        "description": "Indicates whether the payment method is available for use."
      },
      "description": {
        "type": "string",
        "description": "Description of the payment method.",
        "nullable": true
      },
      "authorizationDate": {
        "type": "string",
        "description": "Payment authorization date.",
        "nullable": true
      },
      "self": {
        "$ref": "#/components/schemas/Self"
      },
      "tid": {
        "type": "string",
        "description": "Provider's unique identifier for the transaction.",
        "nullable": true
      },
      "nsu": {
        "type": "string",
        "description": "Provider's unique sequential number for the transaction.",
        "nullable": true
      },
      "returnCode": {
        "type": "string",
        "description": "Connector return code.",
        "nullable": true
      },
      "returnMessage": {
        "type": "string",
        "description": "Connector return message.",
        "nullable": true
      },
      "status": {
        "type": "string",
        "description": "Payment status."
      },
      "connector": {
        "type": "string",
        "description": "Connector name.",
        "nullable": true
      },
      "ConnectorResponses": {
        "type": "array",
        "description": "Array containing connector responses information.",
        "nullable": true,
        "items": {
          "type": "object",
          "description": "Connector responses information.",
          "properties": {
            "Tid": {
              "type": "string",
              "description": "Provider's unique identifier for the transaction."
            },
            "ReturnCode": {
              "type": "string",
              "description": "Connector return code.",
              "nullable": true
            },
            "Message": {
              "type": "string",
              "description": "Connector return message.",
              "nullable": true
            },
            "authId": {
              "type": "string",
              "description": "Authorization identification.",
              "nullable": true
            },
            "nsu": {
              "type": "string",
              "description": "Provider's unique sequential number for the transaction."
            }
          }
        }
      },
      "connectorResponse": {
        "type": "array",
        "description": "Array containing connector response information.",
        "nullable": true,
        "items": {
          "type": "object",
          "description": "Connector response information.",
          "properties": {
            "Tid": {
              "type": "string",
              "description": "Provider's unique identifier for the transaction."
            },
            "ReturnCode": {
              "type": "string",
              "description": "Connector return code.",
              "nullable": true
            },
            "Message": {
              "type": "string",
              "description": "Connector return message.",
              "nullable": true
            },
            "authId": {
              "type": "string",
              "description": "Authorization identification.",
              "nullable": true
            },
            "nsu": {
              "type": "string",
              "description": "Provider's unique sequential number for the transaction."
            }
          }
        }
      },
      "ShowConnectorResponses": {
        "type": "boolean",
        "description": "Indicates whether to display connector responses."
      },
      "value": {
        "type": "number",
        "description": "Payment value."
      },
      "installmentsInterestRate": {
        "type": "number",
        "description": "The interest rate."
      },
      "installmentsValue": {
        "type": "number",
        "description": "The value of each installment."
      },
      "referenceValue": {
        "type": "number",
        "description": "Value amount of the payment without interest applied. This value is the same as the {value` field when `installmentsInterestRate` is 0.0."
      },
      "installments": {
        "type": "number",
        "description": "Number of installments."
      },
      "currencyCode": {
        "type": "string",
        "description": "Currency Code in ISO 4217 standard.",
        "nullable": true
      },
      "provider": {
        "type": "string",
        "description": "Provider name.",
        "nullable": true
      },
      "isBillingAddressDifferent": {
        "type": "boolean",
        "description": "Indicates whether the invoice address is different from the purchase delivery address.",
        "nullable": true
      },
      "isRegexValid": {
        "type": "boolean",
        "description": "Confirms that the [Regex](https://regexr.com/) rule is valid.",
        "nullable": true
      },
      "isLuhnValid": {
        "type": "boolean",
        "description": "Confirms that the [Luhn](https://en.wikipedia.org/wiki/Luhn_algorithm) rule is valid.",
        "nullable": true
      },
      "fields": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Fields1"
        },
        "description": "Field containing information and values \u200b\u200bof payment parameters."
      },
      "sheets": {
        "type": "string",
        "description": "Sheets information.",
        "nullable": true
      },
      "originalPaymentId": {
        "type": "string",
        "description": "Original payment identification, if applicable.",
        "nullable": true
      }
    }
  }
}