VTEX · Schema

2.SendPaymentsPublicRequest

Send payments information public request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentSystem number Payment system identification.
installments number Number of installments.
currencyCode string Currency code in ISO 4217 standard.
value number Payment value.
installmentsInterestRate number The interest rate.
installmentsValue number The value of each installment.
referenceValue number Value amount of the payment without interest applied. This value is the same as the `value` field when `installmentsInterestRate` is `0.0`.
fields object
transaction object
View JSON Schema on GitHub

JSON Schema

vtex-2sendpaymentspublicrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/2.SendPaymentsPublicRequest",
  "title": "2.SendPaymentsPublicRequest",
  "required": [
    "paymentSystem",
    "installments",
    "currencyCode",
    "value",
    "installmentsInterestRate",
    "installmentsValue",
    "referenceValue",
    "fields",
    "transaction"
  ],
  "type": "object",
  "description": "Send payments information public request body information.",
  "properties": {
    "paymentSystem": {
      "type": "number",
      "description": "Payment system identification.",
      "example": 17
    },
    "installments": {
      "type": "number",
      "description": "Number of installments.",
      "example": 1
    },
    "currencyCode": {
      "type": "string",
      "description": "Currency code in ISO 4217 standard.",
      "example": "BRL"
    },
    "value": {
      "type": "number",
      "description": "Payment value.",
      "example": 15000
    },
    "installmentsInterestRate": {
      "type": "number",
      "description": "The interest rate.",
      "example": 0
    },
    "installmentsValue": {
      "type": "number",
      "description": "The value of each installment.",
      "example": 0
    },
    "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`.",
      "example": 15000
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "transaction": {
      "$ref": "#/components/schemas/Transaction"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-2sendpaymentspublicrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.