VTEX · Example Payload

Vtex Rulebyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Rulebyid Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "RuleById",
  "method": "GET",
  "path": "/api/pvt/rules/{ruleId}",
  "summary": "VTex Get payment rule by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "9e11ed95-4b7f-4445-a53e-2512f260ff1c",
        "name": "American Express - ",
        "salesChannels": [
          {
            "id": ":ALL:"
          }
        ],
        "paymentSystem": {
          "id": 1,
          "name": "American Express",
          "implementation": null
        },
        "connector": {
          "implementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector",
          "affiliationId": "08a0844b-4aab-4f1b-beed-b3889649534b"
        },
        "issuer": {
          "name": null
        },
        "antifraud": {
          "implementation": null,
          "affiliationId": null
        },
        "installmentOptions": {
          "dueDateType": 0,
          "interestRateMethod": 0,
          "minimumInstallmentValue": 1,
          "installments": [
            {
              "ruleId": null,
              "quantity": 12,
              "value": 0,
              "interestRate": 1.86,
              "isExternalInstallmentService": null,
              "interestTax": 0
            },
            {
              "ruleId": null,
              "quantity": 18,
              "value": 0,
              "interestRate": 1.9,
              "isExternalInstallmentService": null,
              "interestTax": 0
            }
          ]
        },
        "isSelfAuthorized": null,
        "requiresAuthentication": null,
        "enabled": true,
        "installmentsService": false,
        "isDefault": null,
        "beginDate": "2023-12-10T17:00:00Z",
        "endDate": "2023-12-22T01:00:00Z",
        "condition": {
          "id": "1",
          "pullRate": 0,
          "name": null
        },
        "multiMerchantList": [
          "test_store_1",
          "test_store_2"
        ],
        "country": {
          "name": null,
          "isoCode": "us"
        },
        "dateIntervals": [
          {
            "start": "* * 11 * * 1,3,4 * -0300",
            "end": "* * 18 * * 1,3,4 * -0300"
          },
          {
            "start": "* * 05 * * * * -0300",
            "end": "* * 23 * * * * -0300"
          }
        ],
        "externalInterest": false,
        "minimumValue": null,
        "deadlines": [],
        "cobrand": {
          "name": null
        },
        "cardLevel": {
          "name": "Premium"
        },
        "excludedBinsRanges": null
      }
    }
  ]
}

Work with this as data

Every example 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 examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example 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 example
curl "https://apis.io/api/v1/examples/vtex-rulebyid-example"
All examples
curl "https://apis.io/api/v1/examples?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.