Vtex Rules 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
{
"operationId": "Rules",
"method": "GET",
"path": "/api/pvt/rules",
"summary": "VTex List all payment rules",
"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
},
{
"id": "01a8d68b-9116-4655-83f8-3380f658ec04",
"name": "QR Code",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 72,
"name": "PicPay",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay",
"affiliationId": "9c4e7bb1-0356-4449-b59f-2e1bbac606f8"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": {
"dueDateType": 1,
"interestRateMethod": 0,
"minimumInstallmentValue": 10,
"installments": [
{
"ruleId": null,
"quantity": 1,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": 0
},
{
"ruleId": null,
"quantity": 2,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": 0
},
{
"ruleId": null,
"quantity": 3,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": 0
},
{
"ruleId": null,
"quantity": 4,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": 0
}
]
},
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": true,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "38426c64-fb35-412c-9900-c3fc0e812109",
"name": "Customer Credit - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 64,
"name": "Customer Credit",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2",
"affiliationId": "7f95a993-4a8c-4d08-a1ae-94625ff1bfb4"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": {
"dueDateType": 0,
"interestRateMethod": 0,
"minimumInstallmentValue": 0,
"installments": [
{
"ruleId": null,
"quantity": 1,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": null
},
{
"ruleId": null,
"quantity": 2,
"value": 0,
"interestRate": 0,
"isExternalInstallmentService": null,
"interestTax": null
}
]
},
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": true,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": [
{
"start": "* * 11 * * 1,3,4 * -0300",
"end": "* * 18 * * 1,3,4 * -0300"
},
{
"start": "* * 05 * * * * -0300",
"end": "* * 23 * * * * -0300"
}
],
"externalInterest": false,
"minimumValue": null,
"deadlines": [
{
"paymentOptions": [
{
"days": 30,
"interestRate": 0
}
]
},
{
"paymentOptions": [
{
"days": 30,
"interestRate": 0
},
{
"days": 60,
"interestRate": 0
}
]
},
{
"paymentOptions": [
{
"days": 15,
"interestRate": 0
},
{
"days": 30,
"interestRate": 0
}
]
}
],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "b7137b64-5b45-4c03-8d75-5ebc320fe537",
"name": "Cash on Delivery",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 17,
"name": "Promissory",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.PromissoryConnector",
"affiliationId": "914a05f6-f48f-4dc1-a41d-ffe3f682b405"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": true,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": {
"id": "1",
"pullRate": 1,
"name": null
},
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "46a75262-6666-43d8-bff5-b6b439a5e074",
"name": "Maestro - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 39,
"name": "Maestro",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.AdyenConnector",
"affiliationId": "1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": true,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "453cb507-294c-40c4-84d3-49ecb02acbbb",
"name": "Visa - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 2,
"name": "Visa",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.MercadoPagoV1.MercadoPagoV1Connector",
"affiliationId": "37806301-73da-4c3f-96e8-7b00fde5fbf2"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "c6a4675f-a3eb-441a-9de0-75e3b784af7b",
"name": "Mastercard - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 4,
"name": "Mastercard",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector",
"affiliationId": "08a0844b-4aab-4f1b-beed-b3889649534b"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "df391a06-e6de-4fbf-ae8f-fd40fecba88f",
"name": "Bank Invoice - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 6,
"name": "Bank Invoice",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.TestConnector",
"affiliationId": "1d884ffd-13d7-419e-a487-da55a2205792"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "220c353e-a298-4f87-ace8-fb4909d34248",
"name": "Google Pay - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 169,
"name": "Google Pay",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3",
"affiliationId": "d983efd2-93ee-46ad-857f-39f933ffdf03"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": true,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "f1442584-f627-4766-a878-dd9427c2cd4b",
"name": "Invoice Payment App",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 6,
"name": "Boleto Banc\u00e1rio",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector",
"affiliationId": "400b66d3-bc9a-4eb8-afc0-f32fe63c7121"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
},
{
"id": "16641c21-d94a-4c0c-9bfa-fb7d646b495f",
"name": "Pix - ",
"salesChannels": [
{
"id": ":ALL:"
}
],
"paymentSystem": {
"id": 125,
"name": "Pix",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_SpinPay",
"affiliationId": "268d2e68-169a-4a85-a670-39409a2a24b6"
},
"issuer": {
"name": null
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": null,
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": null,
"endDate": null,
"condition": null,
"multiMerchantList": null,
"country": null,
"dateIntervals": null,
"externalInterest": false,
"minimumValue": null,
"deadlines": [],
"cobrand": {
"name": null
},
"cardLevel": {
"name": null
},
"excludedBinsRanges": null
}
]
}
]
}