Vtex Insertrule 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": "InsertRule",
"method": "POST",
"path": "/api/pvt/rules",
"summary": "VTex Insert a new payment rule",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"name": "Test_API_2",
"salesChannels": [
{
"id": "1"
}
],
"paymentSystem": {
"id": 8,
"name": "Hipercard",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd"
},
"issuer": {
"name": "barclays"
},
"antifraud": {
"implementation": null,
"affiliationId": null
},
"installmentOptions": {
"dueDateType": 1,
"interestRateMethod": 2,
"minimumInstallmentValue": 50,
"installments": [
{
"ruleId": null,
"quantity": 6,
"value": 0,
"interestRate": 15,
"isExternalInstallmentService": null,
"interestTax": 0
}
]
},
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": "2023-12-10T17:00:00Z",
"endDate": "2023-12-22T01:00:00Z",
"condition": {
"id": "1",
"pullRate": 0,
"name": null
},
"multiMerchantList": [
"cosmetics2"
],
"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": "business"
},
"excludedBinsRanges": null
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"id": "c997267e-39bf-4217-a890-a503f6a7dc47",
"name": "Test_API_2",
"salesChannels": [
{
"id": "1"
}
],
"paymentSystem": {
"id": 8,
"name": "Hipercard",
"implementation": null
},
"connector": {
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd"
},
"issuer": {
"name": "barclays"
},
"antifraud": null,
"installmentOptions": {
"dueDateType": 1,
"interestRateMethod": 2,
"minimumInstallmentValue": 50,
"installments": [
{
"ruleId": null,
"quantity": 6,
"value": 0,
"interestRate": 15,
"isExternalInstallmentService": null,
"interestTax": 0
}
]
},
"isSelfAuthorized": null,
"requiresAuthentication": null,
"enabled": false,
"installmentsService": false,
"isDefault": null,
"beginDate": "2023-12-10T17:00:00Z",
"endDate": "2023-12-22T01:00:00Z",
"condition": {
"id": "1",
"pullRate": 0,
"name": null
},
"multiMerchantList": [
"cosmetics2"
],
"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": "business"
},
"excludedBinsRanges": null
}
}
]
}