Payments Gateway API
>ℹ️ Onboarding guide
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://vtex.local"
},
{
"description": "VTEX server url",
"url": "https://{accountName}.vtexpayments.com.br",
"variables": {
"accountName": {
"default": "{accountName}",
"description": "Name of the VTEX account. Used as part of the URL"
}
}
}
],
"info": {
"contact": {},
"description": ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Payments Gateway API allows you to get payment data and process your store's transactions.",
"title": "Payments Gateway API",
"version": "1.0",
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Payments Gateway API.json",
"version": "3.0"
}
],
"x-providerName": "vtex.local",
"x-serviceName": "Payments-Gateway-API",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg"
}
},
"security": [
{
"appKey": [],
"appToken": []
}
],
"tags": [
{
"description": "We provided payment methods configuration that allow our sellers to configure installment options and from that configuration we generate an installment service.",
"name": "Installments"
},
{
"name": "Configuration"
},
{
"description": "This is meant to explain the requests that are necessary to complete a transaction using PCI Gateway.",
"name": "Transaction Process"
},
{
"description": "After one transaction is authorized, there is remaining to do some calls in order to complete a transaction and its payments. We explain the settle process, cancel authorized payments process, and refund process by using examples.",
"name": "Transaction Flow"
}
],
"paths": {
"/api/pub/transactions/{transactionId}/payments": {
"post": {
"deprecated": false,
"description": "The second step to create a new transaction. Here, you have the option to send the data in three diferent ways: doing a private request, a public request or a private request that uses a saved Credit Card. ",
"operationId": "2.SendPaymentsPublic",
"parameters": [
{
"description": "",
"explode": true,
"in": "query",
"name": "orderId",
"required": true,
"schema": {
"example": "{{orderId}}",
"type": "string"
},
"style": "form"
},
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": [
{
"currencyCode": "BRL",
"fields": {
"accountId": "",
"address": null,
"callbackUrl": "",
"cardNumber": "5378244888889174",
"document": "8041734561",
"dueDate": "10/19",
"holderName": "UserTest",
"validationCode": "231"
},
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"paymentSystem": 4,
"referenceValue": 100,
"transaction": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"value": 100
}
],
"schema": {
"description": "",
"items": {
"$ref": "#/components/schemas/2.SendPaymentsPublicRequest"
},
"type": "array"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "2.1 Send Payments Information Public",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/affiliations": {
"get": {
"deprecated": false,
"description": "Returns all affiliations that your provider can handle.",
"operationId": "Affiliations",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Affiliations",
"tags": [
"Configuration"
]
},
"post": {
"deprecated": false,
"description": "Creates a new affiliation and returns a successful response.",
"operationId": "InsertAffiliation",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"configuration": [
{
"name": "HowTo",
"value": "https://developercielo.github.io/Habilitacao-meios-de-pagamento/"
},
{
"name": "MerchantId",
"value": "sampleData"
},
{
"name": "MerchantKey",
"value": "sampleData"
},
{
"name": "softDescriptor",
"value": "teste"
},
{
"name": "bankInvoiceProvider",
"value": "Disabled"
},
{
"name": "bankIDebitProvider",
"value": "Disabled"
},
{
"name": "useEarlySecurityCapture",
"value": "0"
},
{
"name": "isProduction",
"value": "false"
},
{
"name": "bankDebitProvider",
"value": "Disabled"
},
{
"name": "Registered",
"value": "false"
}
],
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"isConfigured": true,
"isdelivered": true,
"name": "CieloV3 - Teste Ellen"
},
"schema": {
"$ref": "#/components/schemas/InsertAffiliationRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Insert Affiliation",
"tags": [
"Configuration"
]
}
},
"/api/pvt/affiliations/{affiliationId}": {
"get": {
"deprecated": false,
"description": "Returns associated data for the specified affiliation Id, like name and implementation, for example.",
"operationId": "AffiliationById",
"parameters": [
{
"description": "",
"in": "path",
"name": "affiliationId",
"required": true,
"schema": {
"example": "e046d326-5421-45ab-95ae-f13d37f260b5",
"type": "string"
}
},
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Affiliation By Id",
"tags": [
"Configuration"
]
},
"put": {
"deprecated": false,
"description": "Returns all affiliations.",
"operationId": "UpdateAffiliation",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "affiliationId",
"required": true,
"schema": {
"example": "e046d326-5421-45ab-95ae-f13d37f260b5",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"configuration": [
{
"name": "HowTo",
"value": "https://developercielo.github.io/Habilitacao-meios-de-pagamento/"
},
{
"name": "MerchantId",
"value": "DATA TEST"
},
{
"name": "MerchantKey",
"value": "DATA TEST"
},
{
"name": "softDescriptor",
"value": "teste"
},
{
"name": "bankInvoiceProvider",
"value": "Disabled"
},
{
"name": "bankIDebitProvider",
"value": "Disabled"
},
{
"name": "useEarlySecurityCapture",
"value": "0"
},
{
"name": "isProduction",
"value": "false"
},
{
"name": "bankDebitProvider",
"value": "Disabled"
},
{
"name": "Registered",
"value": "false"
}
],
"id": "61c3b25b-554d-41a4-b989-a0ba215e4bba",
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"isConfigured": true,
"isdelivered": true,
"name": "CieloV3 - Teste Ellen"
},
"schema": {
"$ref": "#/components/schemas/UpdateAffiliationRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Update Affiliation",
"tags": [
"Configuration"
]
}
},
"/api/pvt/installments": {
"get": {
"deprecated": false,
"description": "Returns the best installment options according to the informed params.",
"operationId": "Installmentsoptions",
"parameters": [
{
"description": "",
"explode": true,
"in": "query",
"name": "request.value",
"required": true,
"schema": {
"example": 10,
"format": "int32",
"type": "integer"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "request.salesChannel",
"required": false,
"schema": {
"example": 1,
"format": "int32",
"type": "integer"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "request.paymentDetails[0].id",
"required": false,
"schema": {
"example": 2,
"format": "int32",
"type": "integer"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "request.paymentDetails[0].value",
"required": false,
"schema": {
"example": 10,
"format": "int32",
"type": "integer"
},
"style": "form"
},
{
"description": "",
"explode": true,
"in": "query",
"name": "request.paymentDetails[0].bin",
"required": false,
"schema": {
"example": 411111,
"format": "int32",
"type": "integer"
},
"style": "form"
},
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"installments": [
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 2,
"isDefault": false,
"name": "ERedeV2 - Nova Visa",
"self": {
"href": "/api/pvt/payment-systems/2"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 3,
"isDefault": false,
"name": "ERedeV2 - Nova Diners",
"self": {
"href": "/api/pvt/payment-systems/3"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 4,
"isDefault": false,
"name": "ERedeV2 - Nova Mastercard",
"self": {
"href": "/api/pvt/payment-systems/4"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 6,
"isDefault": false,
"name": "Boleto Bancário - WEG79AKC8R529",
"self": {
"href": "/api/pvt/payment-systems/6"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 7,
"isDefault": false,
"name": "ERedeV2 - Nova Aura",
"self": {
"href": "/api/pvt/payment-systems/7"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 8,
"isDefault": false,
"name": "Hipercard - CNRYOV0ANPZAOR",
"self": {
"href": "/api/pvt/payment-systems/8"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
},
{
"interestRate": 0,
"quantity": 2,
"value": 5
}
],
"payment": {
"bin": null,
"id": 9,
"isDefault": false,
"name": "Elo/Mundipagg",
"self": {
"href": "/api/pvt/payment-systems/9"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 12,
"isDefault": false,
"name": "PayPal - 6U0DTI3M3OKO6R",
"self": {
"href": "/api/pvt/payment-systems/12"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 16,
"isDefault": false,
"name": "Vale/GiftCard",
"self": {
"href": "/api/pvt/payment-systems/16"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
},
{
"interestRate": 0,
"quantity": 2,
"value": 5
},
{
"interestRate": 0,
"quantity": 3,
"value": 3.33
}
],
"payment": {
"bin": null,
"id": 18,
"isDefault": false,
"name": "Mercado Pago - XBKAG5IMTJRA4I",
"self": {
"href": "/api/pvt/payment-systems/18"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 26,
"isDefault": false,
"name": "PagSeguro - HRXC4VO76NU3DI",
"self": {
"href": "/api/pvt/payment-systems/26"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 33,
"isDefault": false,
"name": "ERedeV2 - Nova Cabal",
"self": {
"href": "/api/pvt/payment-systems/33"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 38,
"isDefault": false,
"name": "Safetypay - Q8J8XIXDSSPDS4I",
"self": {
"href": "/api/pvt/payment-systems/38"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 43,
"isDefault": false,
"name": "PagosWeb - PDA8UKCUTMX6R",
"self": {
"href": "/api/pvt/payment-systems/43"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 49,
"isDefault": false,
"name": "PayPalPlus - LW5HDKPMD3G14I",
"self": {
"href": "/api/pvt/payment-systems/49"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430004,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430004"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430014,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430014"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430201,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430201"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430202,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430202"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430203,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430203"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430208,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430208"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430210,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430210"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430220,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430220"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430222,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430222"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430230,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430230"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430231,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430231"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430232,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430232"
},
"value": 10
}
}
],
"value": 10
},
"schema": {
"$ref": "#/components/schemas/ValidRequest"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "public, max-age=900",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "5453",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 19:55:36 GMT",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"X-Accel-Expires": {
"content": {
"text/plain": {
"example": "900",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "72eaea00-61de-49f5-b581-34ac294e317a",
"schema": {
"type": "string"
}
}
}
}
}
},
"400": {
"content": {
"application/json": {
"example": {
"error": {
"code": "1",
"exception": null,
"message": "Value must be greater than Zero"
}
},
"schema": {
"$ref": "#/components/schemas/InvalidRequestValue"
}
}
},
"description": "Bad Request"
}
},
"summary": "Installments options",
"tags": [
"Installments"
]
}
},
"/api/pvt/merchants/payment-systems": {
"get": {
"deprecated": false,
"description": "Returns enabled payment methods, like visa, master, bankissueinvoice that are shown for the final user and enabled to receive payment.",
"operationId": "AvailablePaymentMethods",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": [
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PayPalPlusConnector",
"description": null,
"dueDate": "2016-04-16T14:52:03.7360354Z",
"fields": null,
"groupName": "PayPalPlus",
"id": 49,
"implementation": "Vtex.PaymentGateway.PayPalPlus.PayPalPlusPayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "PayPalPlus",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PayPalPlusConnector",
"id": "2d062b92-f247-4935-a237-8e309e2b4422"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": true,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.MercadoPagoConnector",
"description": null,
"dueDate": "2016-04-23T02:52:03.7360354Z",
"fields": null,
"groupName": "MercadoPago",
"id": 18,
"implementation": "Vtex.PaymentGateway.RedirectPayments.MercadoPagoPayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Mercado Pago",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.MercadoPagoConnector",
"id": "8a455c9f-fa4e-40c6-b68d-cb91eeee4c87"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.BraspagConnector",
"description": null,
"dueDate": "2016-04-18T02:52:03.7516359Z",
"fields": null,
"groupName": "creditCard",
"id": 8,
"implementation": "Vtex.PaymentGateway.CreditCard.Hipercard",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Hipercard",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.BraspagConnector",
"id": "dbf01be3-e701-4791-a2f0-9ce7f2540d5f"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "bd44b35b-11e1-4684-8a42-db8ca4215b99"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999999999999999999",
"regex": "^606282|^3841(?:[0|4|6]{1})0",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
1,
1,
1
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": true,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceBBConnector",
"description": null,
"dueDate": "2016-04-20T23:59:59.999Z",
"fields": null,
"groupName": "bankInvoice",
"id": 6,
"implementation": "Vtex.PaymentGateway.BankIssuedInvoice.BankIssuedInvoicePayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Boleto Bancário",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceBBConnector",
"id": "c1ab4c11-5da3-41a5-9933-73639ce69cdf"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector",
"description": null,
"dueDate": "2016-04-16T02:52:03.7516359Z",
"fields": null,
"groupName": "giftCard",
"id": 16,
"implementation": "Vtex.PaymentGateway.GiftCard.VtexGiftCard",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Vale",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector",
"id": "fb238965-9f24-45c1-8f85-3aae93d3f752"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.MundipaggConnector",
"description": null,
"dueDate": "2016-04-18T02:52:03.767237Z",
"fields": null,
"groupName": "creditCard",
"id": 9,
"implementation": "Vtex.PaymentGateway.CreditCard.Elo",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Elo",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.MundipaggConnector",
"id": "c6ddf433-a516-4aa7-abb6-bda70d5243b2"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999 9999 9999 9999",
"regex": "^((((438935)|(509048)|(509049)|(509067)|(509069)|(509050)|(509074)|(509068)|(509040)|(509045)|(509051)|(509046)|(509066)|(509047)|(509042)|(509052)|(509043)|(509064)|(509040)|(636368)|(636368)|(504175)|(451416)|(636297))\\d{0,10})|((5067)|(4576)|(4011))\\d{0,12})$",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": true,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.SafetyPay.SafetyPayConnector",
"description": null,
"dueDate": "2016-04-16T02:52:03.767237Z",
"fields": null,
"groupName": "safetypay",
"id": 38,
"implementation": "Vtex.PaymentGateway.RedirectPayments.SafetypayPayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Safetypay",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.SafetyPay.SafetyPayConnector",
"id": "d6027c18-4801-4ef9-b6f2-ca2163be8a32"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"description": null,
"dueDate": "2016-04-18T02:52:03.767237Z",
"fields": null,
"groupName": "creditCard",
"id": 4,
"implementation": "Vtex.PaymentGateway.CreditCard.Mastercard",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Mastercard",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "3180c470-5b2a-4fd2-b063-f28a19c79e8c"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.TestConnector",
"id": "a4472931-4508-4376-ba5a-11dac634b397"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999 9999 9999 9999",
"regex": "^5(1(0(0(0([0-9])|[1-9][0-9])|[1-9][0-9]{0})|[1-9][0-9]{0})|3(0(4(0([0-9]))|[0-3][0-9]{0}))|2[0-9]{0})|^5(3(0(4(2([0-9])|[3-9][0-9])|[5-9][0-9]{0})|[1-9][0-9]{0})|5(9(9(9([0-9])|[0-8][0-9])|[0-8][0-9]{0})|[0-8][0-9]{0})|4[0-9]{0})",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"description": null,
"dueDate": "2016-04-18T02:52:03.767237Z",
"fields": null,
"groupName": "creditCard",
"id": 2,
"implementation": "Vtex.PaymentGateway.CreditCard.Visa",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Visa",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "06137299-ed94-4db2-a7e0-0cbfa7602e42"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.RedecardConnector",
"id": "a944ceb5-a43d-4b90-b625-5bde2b4db5b8"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagSeguroDirect.PagSeguroConnector",
"id": "c132f93f-c9e3-402b-b161-89c8fb7f0651"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999 9999 9999 9999",
"regex": "^4",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"description": null,
"dueDate": "2016-04-18T02:52:03.767237Z",
"fields": null,
"groupName": "creditCard",
"id": 3,
"implementation": "Vtex.PaymentGateway.CreditCard.Diners",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Diners",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "a2c6087d-9efd-40a6-a573-a13cd7ec69ce"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999 999999 9999",
"regex": "^3(0[0-5]|[68][0-9])[0-9]{11}$",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"description": null,
"dueDate": "2016-04-18T02:52:03.7828384Z",
"fields": null,
"groupName": "creditCard",
"id": 7,
"implementation": "Vtex.PaymentGateway.CreditCard.Aura",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Aura",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.CieloConnector",
"id": "519046a1-36f2-45d8-852a-610fc1847b30"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.MundipaggConnector",
"id": "5f41dd10-a338-4e43-8b56-ec72408ff731"
},
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "420f9a00-dcfe-410d-b51f-5bf8461d2326"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999999999999999999",
"regex": "^50[0-9]{17}$",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": []
}
},
{
"affiliationId": null,
"allowCommercialCondition": true,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": true,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"description": null,
"dueDate": "2016-04-18T02:52:03.7828384Z",
"fields": null,
"groupName": "creditCard",
"id": 33,
"implementation": "Vtex.PaymentGateway.CreditCard.Cabal",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "Cabal",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector",
"id": "e243df96-cf1b-4d26-9a3a-de7a02feb657"
}
],
"validator": {
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"mask": "9999 9999 9999 9999",
"regex": "6(0(4(2(0([1-9])|1([0-9])))))|6(0(3(5(2(2)))))|5(8(9(6(5(7)))))|6(0(4(2(2([1-9])|[3-9][0-9])|4(0(0))|3[0-9]{0})))",
"useBillingAddress": true,
"useCardHolderName": true,
"useCvv": true,
"useExpirationDate": true,
"validCardLengths": null,
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
]
}
},
{
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": true,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagSeguro.PagSeguroConnector",
"description": null,
"dueDate": "2016-04-22T02:52:03.7828384Z",
"fields": null,
"groupName": "pagSeguro",
"id": 26,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagSeguroPayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "PagSeguro",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagSeguro.PagSeguroConnector",
"id": "9bdd6af3-6edd-4df8-8ba4-3b8f7b953bea"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430004,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "RedPagos (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430014,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "Abitab (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430201,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "VISA (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430202,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "MASTER (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430203,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "OCA (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430208,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "DINERS (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430210,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "LIDER (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430220,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "VISA BROU (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430222,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "VISA MAS BROU (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430230,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "VISA SANTANDER (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.406849Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430231,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "MASTER SANTANDER (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
{
"affiliationId": "49de1a21-ca32-4e66-855c-59ddfae31995",
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": true,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"description": null,
"dueDate": "2016-04-16T02:52:04.4224366Z",
"fields": null,
"groupName": "PagosWeb",
"id": 430232,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PagosWebPayment",
"isAvailable": true,
"isCustom": true,
"isSelfAuthorized": false,
"name": "VISA SANTANDER HIPER (PagosWeb) ",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PagosWebConnector",
"id": "22974080-1b2e-4ed2-a526-6d036179d50e"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
}
],
"schema": {
"items": {
"$ref": "#/components/schemas/PaymentSystemsResponse"
},
"type": "array"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "28362",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 02:52:04 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "8641c8ee-23a9-4405-88df-bd912d546df1",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Available Payment Methods",
"tags": [
"Configuration"
]
}
},
"/api/pvt/rules": {
"get": {
"deprecated": false,
"description": "Returns all rules conditions your provider can handle.",
"operationId": "Rules",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Rules",
"tags": [
"Configuration"
]
},
"post": {
"deprecated": false,
"description": "Creates a new rule and returns a successful response.",
"operationId": "InsertRule",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"antifraud": {
"affiliationId": null,
"implementation": null
},
"beginDate": null,
"condition": null,
"connector": {
"affiliationId": "e046d326-5421-45ab-95ae-f13d37f260b5",
"implementation": "Vtex.PaymentGateway.Connectors.PromissoryConnector"
},
"country": null,
"dateIntervals": null,
"enabled": true,
"endDate": null,
"installmentOptions": null,
"installmentsService": null,
"isDefault": false,
"isSelfAuthorized": null,
"issuer": {
"name": null
},
"multiMerchantList": null,
"name": "Cash - Custom",
"paymentSystem": {
"id": 47,
"implementation": null,
"name": "Cash"
},
"requiresAuthentication": null,
"salesChannels": [
{
"id": ":ALL:"
}
]
},
"schema": {
"$ref": "#/components/schemas/InsertRuleRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Insert Rule",
"tags": [
"Configuration"
]
}
},
"/api/pvt/rules/{ruleId}": {
"delete": {
"deprecated": false,
"description": "Deletes rules by specified Id.",
"operationId": "Rule",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Delete Rule",
"tags": [
"Configuration"
]
},
"get": {
"deprecated": false,
"description": "Returns rule by specified RuleId.",
"operationId": "RuleById",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Rule By Id",
"tags": [
"Configuration"
]
},
"put": {
"deprecated": false,
"description": "Update Rule.",
"operationId": "PutRuleById",
"parameters": [
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"antifraud": {
"affiliationId": "f952588c-8b41-41cc-a06f-c0f48f7320ef"
},
"beginDate": "0001-01-01T00:00:00",
"condition": null,
"connector": {
"affiliationId": "d0d7097e-0959-43dc-b335-852eda7b2992",
"implementation": "Vtex.PaymentGateway.Connectors.MundipaggConnector"
},
"country": null,
"dateIntervals": null,
"enabled": true,
"endDate": "9999-12-31T23:59:59.9999999",
"id": "eff4f368-b671-443b-b5a9-82616e87ea1c",
"installmentOptions": {
"interestRateMethod": null
},
"isDefault": null,
"isSelfAuthorized": null,
"issuer": {
"name": null
},
"multiMerchantList": null,
"name": "Visa gatewayqa",
"paymentSystem": {
"id": 2,
"implementation": null,
"name": "Visa"
},
"salesChannels": [
{
"id": "2"
}
]
},
"schema": {
"$ref": "#/components/schemas/RuleByIdRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Rule By Id",
"tags": [
"Configuration"
]
}
},
"/api/pvt/transactions": {
"post": {
"deprecated": false,
"description": "This request is the first step to create a new transaction.",
"operationId": "1.Createanewtransaction",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"channel": "{{accountName}}",
"referenceId": "1234567",
"salesChannel": "1",
"urn": "",
"value": 100
},
"schema": {
"$ref": "#/components/schemas/1.CreateanewtransactionRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"acceptHeader": null,
"antifraudAffiliationId": null,
"antifraudTid": null,
"authorizationDate": null,
"authorizationToken": null,
"buyer": null,
"cancelationDate": null,
"cancelationToken": null,
"cancellations": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/cancellations"
},
"channel": "gatewayqa",
"commitmentDate": null,
"commitmentToken": null,
"fields": [
{
"name": "owner",
"value": "vtexappkey-appvtex"
},
{
"name": "channel",
"value": "gatewayqa"
},
{
"name": "salesChannel",
"value": "1"
}
],
"id": "85A3A4B536E64C108FB941CC3CF5A9A1",
"interactions": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/interactions"
},
"ipAddress": null,
"markedForRecurrence": false,
"owner": "vtexappkey-appvtex",
"payments": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/payments"
},
"receiverUri": "https://gatewayqa.vtexpayments.com.br/split/85A3A4B536E64C108FB941CC3CF5A9A1/payments",
"referenceKey": "1234567",
"refundingDate": null,
"refundingToken": null,
"refunds": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/refunds"
},
"salesChannel": "1",
"settlements": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/settlements"
},
"softDescriptor": null,
"startDate": "2016-04-15T02:52:24.3801586Z",
"status": "Started",
"timeoutStatus": 0,
"totalRefunds": 0,
"transactionId": "85A3A4B536E64C108FB941CC3CF5A9A1",
"urn": null,
"userAgent": null,
"value": 100
},
"schema": {
"$ref": "#/components/schemas/StartTransactionResponse"
}
}
},
"description": "",
"headers": {
"Access-Control-Allow-Credentials": {
"content": {
"text/plain": {
"example": "true",
"schema": {
"type": "string"
}
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"example": "chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo",
"schema": {
"type": "string"
}
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "1348",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 02:52:25 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "7c30580a-88a0-4149-8a63-3b3a72ea92f9",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "1. Starts a new transaction",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}": {
"get": {
"deprecated": false,
"description": "Returns associated data for the specified transaction id, like value and status, for exemple.",
"operationId": "TransactionDetails",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"acceptHeader": "application/json",
"antifraudAffiliationId": null,
"antifraudTid": null,
"authorizationDate": null,
"authorizationToken": null,
"buyer": null,
"cancelationDate": null,
"cancelationToken": null,
"cancellations": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/cancellations"
},
"channel": "gatewayqa",
"commitmentDate": null,
"commitmentToken": null,
"fields": [
{
"name": "owner",
"value": "vtexappkey-appvtex"
},
{
"name": "channel",
"value": "gatewayqa"
},
{
"name": "salesChannel",
"value": "1"
},
{
"name": "markedForRecurrence",
"value": "true"
},
{
"name": "parentMerchant",
"value": "648a4ce7-c16d-4fba-9854-072384636a32"
},
{
"name": "orderId",
"value": "1234567"
},
{
"name": "ip",
"value": "10.0.4.12"
},
{
"name": "userAgent",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36"
},
{
"name": "acceptHeader",
"value": "application/json"
},
{
"name": "cart",
"value": "{\"items\":[\r\n {\r\n \"id\":\"122323\",\r\n \"name\":\"Tenis Preto I\",\r\n \"value\":1000,\r\n \"quantity\":1,\r\n \"shippingDiscount\":0,\r\n \"discount\":50\r\n },\r\n {\r\n \"id\":\"122324\",\r\n \"name\":\"Tenis Nike Azul\",\r\n \"value\":1100,\r\n \"quantity\":1,\r\n \"shippingDiscount\":0,\r\n \"discount\":50\r\n }\r\n ],\"freight\":200,\r\n \"tax\":0\r\n }"
},
{
"name": "clientProfileData",
"value": "{\"email\":\"teste@teste.com\",\"firstName\":\"Joao\",\"lastName\":\"Baptista\",\"document\":\"06134240040\",\"phone\":\"+551433118100\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"postalCode\":\"22011-050\",\"address\":{\"receiverName\":\"Ellen\",\"postalCode\":\"22011050\",\"city\":\"RIO DE JANEIRO\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"RUA GENERAL AZEVEDO PIMENTEL\",\"number\":\"12345\",\"neighborhood\":\"COPACABANA\",\"complement\":\"APTO 302\",\"reference\":null},\"gender\":null,\"birthDate\":null,\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":null,\"isFirstPurchase\":false,\"id\":null}"
},
{
"name": "shippingData",
"value": "{\"receiverName\":\"Rodrigo Saens\",\"postalCode\":\"65035430\",\"city\":\"SAO LUIS\",\"state\":\"MA\",\"country\":\"BRA\",\"street\":\"AV NEWTON \",\"number\":\"321\",\"neighborhood\":\"MONTE CATELO\",\"complement\":\"APTO 102\",\"reference\":null}"
}
],
"id": "A3BDE325F76B4B758B398D900DF06150",
"interactions": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/interactions"
},
"ipAddress": "10.0.4.12",
"markedForRecurrence": true,
"owner": "vtexappkey-appvtex",
"payments": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/payments"
},
"receiverUri": null,
"referenceKey": "1234567",
"refundingDate": null,
"refundingToken": null,
"refunds": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/refunds"
},
"salesChannel": "1",
"settlements": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/settlements"
},
"softDescriptor": null,
"startDate": "2016-04-15T02:36:38",
"status": "Cancelling",
"timeoutStatus": 2,
"totalRefunds": 0,
"transactionId": "A3BDE325F76B4B758B398D900DF06150",
"urn": null,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36",
"value": 100
},
"schema": {
"$ref": "#/components/schemas/TransactionDetailsResponse"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "3326",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 02:51:28 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "411c3fc9-e504-47d4-a0ee-6b88fb95f129",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Transaction Details",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}/additional-data": {
"post": {
"deprecated": false,
"description": "The third step to create a new transaction. It will send the additional related data to the transaction, like billig and shipping adress.",
"operationId": "3.SendAdditionalData",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Transaction identification.",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "",
"items": {
"$ref": "#/components/schemas/3.SendAdditionalDataRequest"
},
"properties": {
"name": {
"description": "Type of data that will be added to the transaction.",
"type": "string"
},
"value": {
"description": "Data to be added to the transaction.",
"type": "string"
}
},
"type": "array"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {},
"description": "OK",
"headers": {}
}
},
"summary": "3. Send Additional Data",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}/authorization-request": {
"post": {
"deprecated": false,
"description": "The fouth and last step to create a new transaction. It will authorized the new transction creation acorrdint to the data previously informed in the latests requests.",
"operationId": "4.Doauthorization",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"prepareForRecurrency": false,
"softDescriptor": "{{accountName}}",
"transactionId": "{{transactionId}}"
},
"schema": {
"$ref": "#/components/schemas/4.DoauthorizationRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Do authorization",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}/cancellation-request": {
"post": {
"deprecated": false,
"description": "Cancel's transaction that was previously approved, but not settled.",
"operationId": "Cancelthetransaction",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"schema": {
"$ref": "#/components/schemas/CancelthetransactionRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Cancel the transaction",
"tags": [
"Transaction Flow"
]
}
},
"/api/pvt/transactions/{transactionId}/payments": {
"post": {
"deprecated": false,
"description": "The second step to create a new transaction. Here, you have the option to send the data in three diferent ways: doing a private request, a public request or a private request that uses a saved Credit Card.",
"operationId": "2.SendPaymentsWithSavedCreditCard",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": [
{
"currencyCode": "BRL",
"fields": {
"accountId": "44D964F2053642E888E3B23549937F87",
"address": null,
"callbackUrl": "",
"firstDigits": "411111",
"validationCode": "231"
},
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"paymentSystem": 2,
"referenceValue": 100,
"transaction": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"value": 100
}
],
"schema": {
"description": "",
"items": {
"$ref": "#/components/schemas/2.SendPaymentsWithSavedCreditCardRequest"
},
"type": "array"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "2.2 Send Payments With Saved Credit Card",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}/payments/{paymentId}": {
"get": {
"deprecated": false,
"description": "Returns associated information details for the specified payment id.",
"operationId": "PaymentDetails",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "paymentId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json; charset=utf-8": {
"example": {
"ConnectorResponses": null,
"ShowConnectorResponses": false,
"allowInstallments": true,
"allowIssuer": true,
"allowNotification": false,
"connector": "E-Rede V2",
"connectorResponse": null,
"currencyCode": null,
"description": null,
"fields": [
{
"name": "affiliationId",
"value": "c4016e3b-9ed9-4735-98dc-f803c93c5e5c"
},
{
"name": "callbackUrl",
"value": "1"
},
{
"name": "baseUrl",
"value": "https://gatewayqa.vtexpayments.com.br:443"
},
{
"name": "cardHolder",
"value": "UserTest"
},
{
"name": "firstDigits",
"value": "444433"
},
{
"name": "lastDigits",
"value": "1111"
},
{
"name": "expiryMonth",
"value": "10"
},
{
"name": "expiryYear",
"value": "2019"
},
{
"name": "accountId",
"value": "A14180691F1D4CC9941202E10C6B1A33"
},
{
"name": "connector",
"value": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector"
}
],
"group": "creditCard",
"id": "712B47E0AB4F4E63BB5FC1DB445AC0B9",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"isAvailable": true,
"isCustom": false,
"merchantName": null,
"paymentSystem": 2,
"paymentSystemName": "Visa",
"provider": null,
"referenceValue": 100,
"returnCode": null,
"returnMessage": null,
"self": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/payments/712B47E0AB4F4E63BB5FC1DB445AC0B9"
},
"sheets": null,
"status": "Received",
"tid": null,
"value": 100
},
"schema": {
"$ref": "#/components/schemas/PaymentDetailsResponse"
}
}
},
"description": "",
"headers": {
"Cache-Control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"example": "1227",
"schema": {
"type": "string"
}
}
}
},
"Date": {
"content": {
"text/plain": {
"example": "Fri, 15 Apr 2016 02:51:48 GMT",
"schema": {
"type": "string"
}
}
}
},
"Expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"Pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"Server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"X-AspNet-Version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"X-Powered-By": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "5f19331b-23f0-444b-a210-49847c50f898",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Payment Details",
"tags": [
"Transaction Process"
]
}
},
"/api/pvt/transactions/{transactionId}/refunding-request": {
"post": {
"deprecated": false,
"description": "Refunds transaction's value that was previously settled.",
"operationId": "Refundthetransaction",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"schema": {
"$ref": "#/components/schemas/RefundthetransactionRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"summary": "Refund the transaction",
"tags": [
"Transaction Flow"
]
}
},
"/api/pvt/transactions/{transactionId}/settlement-request": {
"post": {
"deprecated": false,
"description": "Settles transaction's value.",
"operationId": "Settlethetransaction",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"value": 100
},
"schema": {
"$ref": "#/components/schemas/SettlethetransactionRequest"
}
}
},
"description": "",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancelledValue": 0,
"connectorRefundedValue": 0,
"message": null,
"processingDate": "2017-08-16T17:40:59.3043324Z",
"refundedToken": null,
"refundedValue": 0,
"status": 13,
"statusDetail": "Finished",
"token": "933276E993ED4452AE4CE2B9B5C6B2F4"
},
"schema": {
"$ref": "#/components/schemas/SettleResponse"
}
}
},
"description": "",
"headers": {
"access-control-allow-credentials": {
"content": {
"text/plain": {
"example": "true",
"schema": {
"type": "string"
}
}
}
},
"access-control-allow-origin": {
"content": {
"text/plain": {
"example": "chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo",
"schema": {
"type": "string"
}
}
}
},
"cache-control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"content-length": {
"content": {
"text/plain": {
"example": "230",
"schema": {
"type": "string"
}
}
}
},
"content-type": {
"content": {
"text/plain": {
"example": "application/json; charset=utf-8",
"schema": {
"type": "string"
}
}
}
},
"date": {
"content": {
"text/plain": {
"example": "Wed, 16 Aug 2017 17:40:59 GMT",
"schema": {
"type": "string"
}
}
}
},
"expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/8.0",
"schema": {
"type": "string"
}
}
}
},
"x-aspnet-version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"x-powered-by": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "e3b5660b-9773-40fe-a267-c616542a063a",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Settle the transaction",
"tags": [
"Transaction Flow"
]
}
},
"/api/pvt/transactions/{transactionId}/settlements": {
"get": {
"deprecated": false,
"description": "Returns associated settlements data for the specified transaction id.",
"operationId": "TransactionSettlementDetails",
"parameters": [
{
"description": "The AppKey configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppKey",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppKey}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The AppToken configured by the merchant (optional configuration)",
"in": "header",
"name": "X-PROVIDER-API-AppToken",
"required": true,
"schema": {
"example": "{{X-PROVIDER-API-AppToken}}",
"type": "string"
},
"style": "simple"
},
{
"description": "The Media type of the body of the request. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Content-Type",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json",
"in": "header",
"name": "Accept",
"required": true,
"schema": {
"example": "application/json",
"type": "string"
},
"style": "simple"
},
{
"description": "",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"actions": [
{
"connectorResponse": null,
"date": "2018-06-05T12:55:58.6262759Z",
"payment": {
"href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE"
},
"paymentId": "87055E7199A446519EB07F1243D5B8BE",
"type": "auto-settlement",
"value": 4499000
}
],
"requests": [
{
"date": "2018-06-05T13:08:22",
"id": "AFB933448FFD4867BF82BCC7026A082C",
"value": 4499000
}
]
},
"schema": {
"$ref": "#/components/schemas/TransactionSettlementDetails"
}
}
},
"description": "",
"headers": {
"cache-control": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"connection": {
"content": {
"text/plain": {
"example": "keep-alive",
"schema": {
"type": "string"
}
}
}
},
"content-length": {
"content": {
"text/plain": {
"example": "384",
"schema": {
"type": "string"
}
}
}
},
"content-type": {
"content": {
"text/plain": {
"example": "application/json; charset=utf-8",
"schema": {
"type": "string"
}
}
}
},
"date": {
"content": {
"text/plain": {
"example": "Tue, 05 Jun 2018 14:52:17 GMT",
"schema": {
"type": "string"
}
}
}
},
"expires": {
"content": {
"text/plain": {
"example": "-1",
"schema": {
"type": "string"
}
}
}
},
"pragma": {
"content": {
"text/plain": {
"example": "no-cache",
"schema": {
"type": "string"
}
}
}
},
"server": {
"content": {
"text/plain": {
"example": "Microsoft-IIS/10.0",
"schema": {
"type": "string"
}
}
}
},
"x-aspnet-version": {
"content": {
"text/plain": {
"example": "4.0.30319",
"schema": {
"type": "string"
}
}
}
},
"x-powered-by": {
"content": {
"text/plain": {
"example": "ASP.NET",
"schema": {
"type": "string"
}
}
}
},
"x-vtex-operation-id": {
"content": {
"text/plain": {
"example": "53a30944-47e6-479f-a5ff-56d0fd7c1f1d",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"summary": "Transaction Settlement Details",
"tags": [
"Transaction Process"
]
}
}
},
"components": {
"schemas": {
"1.CreateanewtransactionRequest": {
"example": {
"channel": "{{accountName}}",
"referenceId": "1234567",
"salesChannel": "1",
"urn": "",
"value": 100
},
"properties": {
"channel": {
"type": "string"
},
"referenceId": {
"type": "string"
},
"salesChannel": {
"type": "string"
},
"urn": {
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"value",
"referenceId",
"channel",
"salesChannel"
],
"title": "1.CreateanewtransactionRequest",
"type": "object"
},
"2.SendPaymentsPrivateRequest": {
"example": {
"currencyCode": "BRL",
"fields": {
"accountId": "",
"address": null,
"callbackUrl": "",
"cardNumber": "4111111111111",
"document": "8041734561",
"dueDate": "10/19",
"holderName": "UserTest",
"validationCode": "231"
},
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"paymentSystem": 2,
"referenceValue": 100,
"transaction": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"value": 100
},
"properties": {
"currencyCode": {
"type": "string"
},
"fields": {
"$ref": "#/components/schemas/Fields"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"transaction": {
"$ref": "#/components/schemas/Transaction"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"paymentSystem",
"installments",
"currencyCode",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"fields",
"transaction"
],
"title": "2.SendPaymentsPrivateRequest",
"type": "object"
},
"2.SendPaymentsPublicRequest": {
"example": {
"currencyCode": "BRL",
"fields": {
"accountId": "",
"address": null,
"callbackUrl": "",
"cardNumber": "5378244888889174",
"document": "8041734561",
"dueDate": "10/19",
"holderName": "UserTest",
"validationCode": "231"
},
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"paymentSystem": 4,
"referenceValue": 100,
"transaction": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"value": 100
},
"properties": {
"currencyCode": {
"type": "string"
},
"fields": {
"$ref": "#/components/schemas/Fields"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"transaction": {
"$ref": "#/components/schemas/Transaction"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"paymentSystem",
"installments",
"currencyCode",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"fields",
"transaction"
],
"title": "2.SendPaymentsPublicRequest",
"type": "object"
},
"2.SendPaymentsWithSavedCreditCardRequest": {
"example": {
"currencyCode": "BRL",
"fields": {
"accountId": "44D964F2053642E888E3B23549937F87",
"address": null,
"callbackUrl": "",
"firstDigits": "411111",
"validationCode": "231"
},
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"paymentSystem": 2,
"referenceValue": 100,
"transaction": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"value": 100
},
"properties": {
"currencyCode": {
"type": "string"
},
"fields": {
"$ref": "#/components/schemas/Fields3"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"transaction": {
"$ref": "#/components/schemas/Transaction"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"paymentSystem",
"installments",
"currencyCode",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"fields",
"transaction"
],
"title": "2.SendPaymentsWithSavedCreditCardRequest",
"type": "object"
},
"3.SendAdditionalDataRequest": {
"example": [
{
"name": "cart",
"value": "{\"items\":[{\"id\":\"122323\",\"name\":\"Tenis Preto I\",\"value\":1000,\"quantity\":1,\"shippingDiscount\":0,\"discount\":50},{\"id\":\"122324\",\"name\":\"Tenis Nike Azul\",\"value\":1100,\"quantity\":1,\"shippingDiscount\":0,\"discount\":50}],\"freight\":200,\"tax\":0}"
},
{
"name": "clientProfileData",
"value": "{\"id\":\"profileId123\",\"email\":\"teste@teste.com\",\"firstName\":\"Joao\",\"lastName\":\"Baptista\",\"document\":\"06134240040\",\"phone\":\"+551433118100\",\"documentType\":\"CPF\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"postalCode\":\"22011-050\",\"address\":{\"receiverName\":\"Ellen\",\"postalCode\":\"22011050\",\"city\":\"RIO DE JANEIRO\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"RUA GENERAL AZEVEDO PIMENTEL\",\"number\":\"12345\",\"neighborhood\":\"COPACABANA\",\"complement\":\"APTO 302\",\"reference\":null},\"gender\":null,\"birthDate\":null,\"corporatePhone\":null,\"isCorporate\":false}"
},
{
"name": "shippingData",
"value": "{\"receiverName\":\"Rodrigo Saens\",\"postalCode\":\"65035430\",\"city\":\"SAO LUIS\",\"state\":\"MA\",\"country\":\"BRA\",\"street\":\"AV NEWTON \",\"number\":\"321\",\"neighborhood\":\"MONTE CATELO\",\"complement\":\"APTO 102\",\"reference\":null}"
}
],
"items": {},
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "3.SendAdditionalDataRequest",
"type": "array"
},
"4.DoauthorizationRequest": {
"example": {
"prepareForRecurrency": false,
"softDescriptor": "{{accountName}}",
"transactionId": "{{transactionId}}"
},
"properties": {
"prepareForRecurrency": {
"type": "boolean"
},
"softDescriptor": {
"type": "string"
},
"transactionId": {
"type": "string"
}
},
"required": [
"transactionId",
"softDescriptor",
"prepareForRecurrency"
],
"title": "4.DoauthorizationRequest",
"type": "object"
},
"Action": {
"example": {
"connectorResponse": null,
"date": "2018-06-05T12:55:58.6262759Z",
"payment": {
"href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE"
},
"paymentId": "87055E7199A446519EB07F1243D5B8BE",
"type": "auto-settlement",
"value": 4499000
},
"properties": {
"connectorResponse": {
"nullable": true,
"type": "string"
},
"date": {
"type": "string"
},
"payment": {
"$ref": "#/components/schemas/Payment1"
},
"paymentId": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"paymentId",
"payment",
"date",
"type",
"value",
"connectorResponse"
],
"title": "Action",
"type": "object"
},
"Antifraud": {
"example": {
"affiliationId": null,
"implementation": null
},
"properties": {
"affiliationId": {
"nullable": true,
"type": "string"
},
"implementation": {
"nullable": true,
"type": "string"
}
},
"required": [
"implementation",
"affiliationId"
],
"title": "Antifraud",
"type": "object"
},
"Antifraud1": {
"example": {
"affiliationId": "f952588c-8b41-41cc-a06f-c0f48f7320ef"
},
"properties": {
"affiliationId": {
"type": "string"
}
},
"required": [
"affiliationId"
],
"title": "Antifraud1",
"type": "object"
},
"Cancellations": {
"example": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/cancellations"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Cancellations",
"type": "object"
},
"CancelthetransactionRequest": {
"default": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"properties": {
"minicart": {
"default": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"description": "This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/vtex-rest-api/reference/orders#getorder) or [Transaction Details](https://developers.vtex.com/vtex-rest-api/reference/transaction-process#transactiondetails) endpoints. It should only be included for transactions with split payment.",
"properties": {
"freight": {
"format": "int32",
"type": "integer"
},
"items": {
"items": {},
"type": "array"
},
"tax": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"value": {
"description": "Value of the purchase.",
"format": "int32",
"type": "integer"
}
},
"required": [
"value"
],
"title": "CancelthetransactionRequest",
"type": "object"
},
"Configuration": {
"example": {
"name": "HowTo",
"value": "https://developercielo.github.io/Habilitacao-meios-de-pagamento/"
},
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "Configuration",
"type": "object"
},
"Connector": {
"example": {
"affiliationId": "e046d326-5421-45ab-95ae-f13d37f260b5",
"implementation": "Vtex.PaymentGateway.Connectors.PromissoryConnector"
},
"properties": {
"affiliationId": {
"type": "string"
},
"implementation": {
"type": "string"
}
},
"required": [
"implementation",
"affiliationId"
],
"title": "Connector",
"type": "object"
},
"Error": {
"example": {
"code": "1",
"exception": null,
"message": "Value must be greater than Zero"
},
"properties": {
"code": {
"type": "string"
},
"exception": {
"nullable": true,
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message",
"exception"
],
"title": "Error",
"type": "object"
},
"Field": {
"example": {
"name": "owner",
"value": "vtexappkey-appvtex"
},
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "Field",
"type": "object"
},
"Fields": {
"example": {
"accountId": "",
"address": null,
"callbackUrl": "",
"cardNumber": "4111111111111",
"document": "8041734561",
"dueDate": "10/19",
"holderName": "UserTest",
"validationCode": "231"
},
"properties": {
"accountId": {
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"cardNumber": {
"type": "string"
},
"document": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"holderName": {
"type": "string"
},
"validationCode": {
"type": "string"
}
},
"required": [
"holderName",
"cardNumber",
"validationCode",
"dueDate",
"document",
"accountId",
"address",
"callbackUrl"
],
"title": "Fields",
"type": "object"
},
"Fields1": {
"example": {
"name": "affiliationId",
"value": "c4016e3b-9ed9-4735-98dc-f803c93c5e5c"
},
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "Fields1",
"type": "object"
},
"Fields3": {
"example": {
"accountId": "44D964F2053642E888E3B23549937F87",
"address": null,
"callbackUrl": "",
"firstDigits": "411111",
"validationCode": "231"
},
"properties": {
"accountId": {
"type": "string"
},
"address": {
"nullable": true,
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"firstDigits": {
"type": "string"
},
"validationCode": {
"type": "string"
}
},
"required": [
"validationCode",
"accountId",
"firstDigits",
"address",
"callbackUrl"
],
"title": "Fields3",
"type": "object"
},
"InsertAffiliationRequest": {
"example": {
"configuration": [
{
"name": "HowTo",
"value": "https://developercielo.github.io/Habilitacao-meios-de-pagamento/"
},
{
"name": "MerchantId",
"value": "sampleData"
},
{
"name": "MerchantKey",
"value": "sampleData"
},
{
"name": "softDescriptor",
"value": "teste"
},
{
"name": "bankInvoiceProvider",
"value": "Disabled"
},
{
"name": "bankIDebitProvider",
"value": "Disabled"
},
{
"name": "useEarlySecurityCapture",
"value": "0"
},
{
"name": "isProduction",
"value": "false"
},
{
"name": "bankDebitProvider",
"value": "Disabled"
},
{
"name": "Registered",
"value": "false"
}
],
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"isConfigured": true,
"isdelivered": true,
"name": "CieloV3 - Teste Ellen"
},
"properties": {
"configuration": {
"description": "",
"items": {
"$ref": "#/components/schemas/Configuration"
},
"type": "array"
},
"implementation": {
"type": "string"
},
"isConfigured": {
"type": "boolean"
},
"isdelivered": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"implementation",
"name",
"configuration",
"isdelivered",
"isConfigured"
],
"title": "InsertAffiliationRequest",
"type": "object"
},
"InsertRuleRequest": {
"example": {
"antifraud": {
"affiliationId": null,
"implementation": null
},
"beginDate": null,
"condition": null,
"connector": {
"affiliationId": "e046d326-5421-45ab-95ae-f13d37f260b5",
"implementation": "Vtex.PaymentGateway.Connectors.PromissoryConnector"
},
"country": null,
"dateIntervals": null,
"enabled": true,
"endDate": null,
"installmentOptions": null,
"installmentsService": null,
"isDefault": false,
"isSelfAuthorized": null,
"issuer": {
"name": null
},
"multiMerchantList": null,
"name": "Cash - Custom",
"paymentSystem": {
"id": 47,
"implementation": null,
"name": "Cash"
},
"requiresAuthentication": null,
"salesChannels": [
{
"id": ":ALL:"
}
]
},
"properties": {
"antifraud": {
"$ref": "#/components/schemas/Antifraud"
},
"beginDate": {
"nullable": true,
"type": "string"
},
"condition": {
"nullable": true,
"type": "string"
},
"connector": {
"$ref": "#/components/schemas/Connector"
},
"country": {
"nullable": true,
"type": "string"
},
"dateIntervals": {
"nullable": true,
"type": "string"
},
"enabled": {
"type": "boolean"
},
"endDate": {
"nullable": true,
"type": "string"
},
"installmentOptions": {
"nullable": true,
"type": "string"
},
"installmentsService": {
"nullable": true,
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isSelfAuthorized": {
"nullable": true,
"type": "string"
},
"issuer": {
"$ref": "#/components/schemas/Issuer"
},
"multiMerchantList": {
"nullable": true,
"type": "string"
},
"name": {
"type": "string"
},
"paymentSystem": {
"$ref": "#/components/schemas/PaymentSystem"
},
"requiresAuthentication": {
"nullable": true,
"type": "string"
},
"salesChannels": {
"description": "",
"items": {
"$ref": "#/components/schemas/SalesChannel"
},
"type": "array"
}
},
"required": [
"name",
"salesChannels",
"paymentSystem",
"connector",
"issuer",
"antifraud",
"installmentOptions",
"isSelfAuthorized",
"requiresAuthentication",
"enabled",
"installmentsService",
"isDefault",
"beginDate",
"endDate",
"condition",
"multiMerchantList",
"country",
"dateIntervals"
],
"title": "InsertRuleRequest",
"type": "object"
},
"Installment": {
"example": {
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 2,
"isDefault": false,
"name": "ERedeV2 - Nova Visa",
"self": {
"href": "/api/pvt/payment-systems/2"
},
"value": 10
}
},
"properties": {
"options": {
"description": "",
"items": {
"$ref": "#/components/schemas/Option"
},
"type": "array"
},
"payment": {
"$ref": "#/components/schemas/Payment"
}
},
"required": [
"payment",
"options"
],
"title": "Installment",
"type": "object"
},
"InstallmentOptions": {
"example": {
"interestRateMethod": null
},
"properties": {
"interestRateMethod": {
"nullable": true,
"type": "string"
}
},
"required": [
"interestRateMethod"
],
"title": "InstallmentOptions",
"type": "object"
},
"Interactions": {
"example": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/interactions"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Interactions",
"type": "object"
},
"InvalidRequestValue": {
"example": {
"error": {
"code": "1",
"exception": null,
"message": "Value must be greater than Zero"
}
},
"properties": {
"error": {
"$ref": "#/components/schemas/Error"
}
},
"required": [
"error"
],
"title": "InvalidRequestValue",
"type": "object"
},
"Issuer": {
"example": {
"name": null
},
"properties": {
"name": {
"nullable": true,
"type": "string"
}
},
"required": [
"name"
],
"title": "Issuer",
"type": "object"
},
"Option": {
"example": {
"interestRate": 0,
"quantity": 1,
"value": 10
},
"properties": {
"interestRate": {
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"value": {
"type": "number"
}
},
"required": [
"quantity",
"value",
"interestRate"
],
"title": "Option",
"type": "object"
},
"Payment": {
"example": {
"bin": null,
"id": 2,
"isDefault": false,
"name": "ERedeV2 - Nova Visa",
"self": {
"href": "/api/pvt/payment-systems/2"
},
"value": 10
},
"properties": {
"bin": {
"nullable": true,
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"isDefault": {
"type": "boolean"
},
"name": {
"nullable": true,
"type": "string"
},
"self": {
"$ref": "#/components/schemas/Self"
},
"value": {
"type": "number"
}
},
"required": [
"id",
"name",
"bin",
"value",
"isDefault",
"self"
],
"title": "Payment",
"type": "object"
},
"Payment1": {
"example": {
"href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Payment1",
"type": "object"
},
"PaymentDetailsResponse": {
"example": {
"ConnectorResponses": null,
"ShowConnectorResponses": false,
"allowInstallments": true,
"allowIssuer": true,
"allowNotification": false,
"connector": "E-Rede V2",
"connectorResponse": null,
"currencyCode": null,
"description": null,
"fields": [
{
"name": "affiliationId",
"value": "c4016e3b-9ed9-4735-98dc-f803c93c5e5c"
},
{
"name": "callbackUrl",
"value": "1"
},
{
"name": "baseUrl",
"value": "https://gatewayqa.vtexpayments.com.br:443"
},
{
"name": "cardHolder",
"value": "UserTest"
},
{
"name": "firstDigits",
"value": "444433"
},
{
"name": "lastDigits",
"value": "1111"
},
{
"name": "expiryMonth",
"value": "10"
},
{
"name": "expiryYear",
"value": "2019"
},
{
"name": "accountId",
"value": "A14180691F1D4CC9941202E10C6B1A33"
},
{
"name": "connector",
"value": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector"
}
],
"group": "creditCard",
"id": "712B47E0AB4F4E63BB5FC1DB445AC0B9",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"isAvailable": true,
"isCustom": false,
"merchantName": null,
"paymentSystem": 2,
"paymentSystemName": "Visa",
"provider": null,
"referenceValue": 100,
"returnCode": null,
"returnMessage": null,
"self": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/payments/712B47E0AB4F4E63BB5FC1DB445AC0B9"
},
"sheets": null,
"status": "Received",
"tid": null,
"value": 100
},
"properties": {
"ConnectorResponses": {
"nullable": true,
"type": "string"
},
"ShowConnectorResponses": {
"type": "boolean"
},
"allowInstallments": {
"type": "boolean"
},
"allowIssuer": {
"type": "boolean"
},
"allowNotification": {
"type": "boolean"
},
"connector": {
"type": "string"
},
"connectorResponse": {
"nullable": true,
"type": "string"
},
"currencyCode": {
"nullable": true,
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"fields": {
"description": "",
"items": {
"$ref": "#/components/schemas/Fields1"
},
"type": "array"
},
"group": {
"type": "string"
},
"id": {
"type": "string"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"isAvailable": {
"type": "boolean"
},
"isCustom": {
"type": "boolean"
},
"merchantName": {
"nullable": true,
"type": "string"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"paymentSystemName": {
"type": "string"
},
"provider": {
"nullable": true,
"type": "string"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"returnCode": {
"nullable": true,
"type": "string"
},
"returnMessage": {
"nullable": true,
"type": "string"
},
"self": {
"$ref": "#/components/schemas/Self"
},
"sheets": {
"nullable": true,
"type": "string"
},
"status": {
"type": "string"
},
"tid": {
"nullable": true,
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"paymentSystem",
"paymentSystemName",
"merchantName",
"group",
"isCustom",
"allowInstallments",
"allowIssuer",
"allowNotification",
"isAvailable",
"description",
"self",
"tid",
"returnCode",
"returnMessage",
"status",
"connector",
"ConnectorResponses",
"connectorResponse",
"ShowConnectorResponses",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"installments",
"currencyCode",
"provider",
"fields",
"sheets"
],
"title": "PaymentDetailsResponse",
"type": "object"
},
"PaymentSystem": {
"example": {
"id": 47,
"implementation": null,
"name": "Cash"
},
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"implementation": {
"nullable": true,
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"implementation"
],
"title": "PaymentSystem",
"type": "object"
},
"PaymentSystemsResponse": {
"example": {
"affiliationId": null,
"allowCommercialCondition": false,
"allowCommercialPolicy": true,
"allowCountry": false,
"allowInstallments": false,
"allowIssuer": false,
"allowMultiple": true,
"allowNotification": false,
"allowPeriod": true,
"antifraudConnectorImplementation": null,
"connectorId": 0,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PayPalPlusConnector",
"description": null,
"dueDate": "2016-04-16T14:52:03.7360354Z",
"fields": null,
"groupName": "PayPalPlus",
"id": 49,
"implementation": "Vtex.PaymentGateway.PayPalPlus.PayPalPlusPayment",
"isAvailable": true,
"isCustom": false,
"isSelfAuthorized": false,
"name": "PayPalPlus",
"requiresDocument": false,
"requiresPhone": false,
"rules": [
{
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PayPalPlusConnector",
"id": "2d062b92-f247-4935-a237-8e309e2b4422"
}
],
"validator": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
}
},
"properties": {
"affiliationId": {
"nullable": true,
"type": "string"
},
"allowCommercialCondition": {
"type": "boolean"
},
"allowCommercialPolicy": {
"type": "boolean"
},
"allowCountry": {
"type": "boolean"
},
"allowInstallments": {
"type": "boolean"
},
"allowIssuer": {
"type": "boolean"
},
"allowMultiple": {
"type": "boolean"
},
"allowNotification": {
"type": "boolean"
},
"allowPeriod": {
"type": "boolean"
},
"antifraudConnectorImplementation": {
"nullable": true,
"type": "string"
},
"connectorId": {
"format": "int32",
"type": "integer"
},
"connectorImplementation": {
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"dueDate": {
"type": "string"
},
"fields": {
"nullable": true,
"type": "string"
},
"groupName": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"implementation": {
"type": "string"
},
"isAvailable": {
"type": "boolean"
},
"isCustom": {
"type": "boolean"
},
"isSelfAuthorized": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requiresDocument": {
"type": "boolean"
},
"requiresPhone": {
"type": "boolean"
},
"rules": {
"description": "",
"items": {
"$ref": "#/components/schemas/Rule"
},
"type": "array"
},
"validator": {
"$ref": "#/components/schemas/Validator"
}
},
"required": [
"id",
"name",
"connectorId",
"requiresDocument",
"requiresPhone",
"implementation",
"connectorImplementation",
"antifraudConnectorImplementation",
"groupName",
"isCustom",
"isSelfAuthorized",
"allowInstallments",
"allowMultiple",
"allowIssuer",
"allowCountry",
"allowCommercialPolicy",
"allowCommercialCondition",
"allowPeriod",
"isAvailable",
"description",
"validator",
"rules",
"fields",
"dueDate",
"allowNotification",
"affiliationId"
],
"title": "PaymentSystemsResponse",
"type": "object"
},
"Payments": {
"example": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/payments"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Payments",
"type": "object"
},
"PaymentsByTransactionResponse": {
"example": {
"ConnectorResponses": null,
"ShowConnectorResponses": false,
"allowInstallments": true,
"allowIssuer": true,
"allowNotification": false,
"connector": "E-Rede V2",
"connectorResponse": null,
"currencyCode": null,
"description": null,
"fields": [
{
"name": "affiliationId",
"value": "c4016e3b-9ed9-4735-98dc-f803c93c5e5c"
},
{
"name": "callbackUrl",
"value": "1"
},
{
"name": "baseUrl",
"value": "https://gatewayqa.vtexpayments.com.br:443"
},
{
"name": "cardHolder",
"value": "UserTest"
},
{
"name": "firstDigits",
"value": "444433"
},
{
"name": "lastDigits",
"value": "1111"
},
{
"name": "expiryMonth",
"value": "10"
},
{
"name": "expiryYear",
"value": "2019"
},
{
"name": "accountId",
"value": "A14180691F1D4CC9941202E10C6B1A33"
},
{
"name": "connector",
"value": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector"
}
],
"group": "creditCard",
"id": "712B47E0AB4F4E63BB5FC1DB445AC0B9",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"isAvailable": true,
"isCustom": false,
"merchantName": null,
"paymentSystem": 2,
"paymentSystemName": "Visa",
"provider": null,
"referenceValue": 100,
"returnCode": null,
"returnMessage": null,
"self": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/payments/712B47E0AB4F4E63BB5FC1DB445AC0B9"
},
"sheets": null,
"status": "Received",
"tid": null,
"value": 100
},
"properties": {
"ConnectorResponses": {
"nullable": true,
"type": "string"
},
"ShowConnectorResponses": {
"type": "boolean"
},
"allowInstallments": {
"type": "boolean"
},
"allowIssuer": {
"type": "boolean"
},
"allowNotification": {
"type": "boolean"
},
"connector": {
"type": "string"
},
"connectorResponse": {
"nullable": true,
"type": "string"
},
"currencyCode": {
"nullable": true,
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"fields": {
"description": "",
"items": {
"$ref": "#/components/schemas/Fields1"
},
"type": "array"
},
"group": {
"type": "string"
},
"id": {
"type": "string"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"isAvailable": {
"type": "boolean"
},
"isCustom": {
"type": "boolean"
},
"merchantName": {
"nullable": true,
"type": "string"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"paymentSystemName": {
"type": "string"
},
"provider": {
"nullable": true,
"type": "string"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"returnCode": {
"nullable": true,
"type": "string"
},
"returnMessage": {
"nullable": true,
"type": "string"
},
"self": {
"$ref": "#/components/schemas/Self"
},
"sheets": {
"nullable": true,
"type": "string"
},
"status": {
"type": "string"
},
"tid": {
"nullable": true,
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"paymentSystem",
"paymentSystemName",
"merchantName",
"group",
"isCustom",
"allowInstallments",
"allowIssuer",
"allowNotification",
"isAvailable",
"description",
"self",
"tid",
"returnCode",
"returnMessage",
"status",
"connector",
"ConnectorResponses",
"connectorResponse",
"ShowConnectorResponses",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"installments",
"currencyCode",
"provider",
"fields",
"sheets"
],
"title": "PaymentsByTransactionResponse",
"type": "object"
},
"ReceivePaymentsResponse": {
"example": {
"ConnectorResponses": null,
"ShowConnectorResponses": false,
"allowInstallments": true,
"allowIssuer": true,
"allowNotification": false,
"connector": "E-Rede V2",
"connectorResponse": null,
"currencyCode": null,
"description": null,
"fields": [
{
"name": "affiliationId",
"value": "c4016e3b-9ed9-4735-98dc-f803c93c5e5c"
},
{
"name": "callbackUrl",
"value": "1"
},
{
"name": "baseUrl",
"value": "https://gatewayqa.vtexpayments.com.br:443"
},
{
"name": "cardHolder",
"value": "UserTest"
},
{
"name": "firstDigits",
"value": "444433"
},
{
"name": "lastDigits",
"value": "1111"
},
{
"name": "expiryMonth",
"value": "10"
},
{
"name": "expiryYear",
"value": "2019"
},
{
"name": "accountId",
"value": "A14180691F1D4CC9941202E10C6B1A33"
},
{
"name": "connector",
"value": "Vtex.PaymentGateway.Connectors.ERedeV2.ERedeV2Connector"
}
],
"group": "creditCard",
"id": "34C219BBF1504A19B0608FB498A48B0B",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 100,
"isAvailable": true,
"isCustom": false,
"merchantName": null,
"paymentSystem": 2,
"paymentSystemName": "Visa",
"provider": null,
"referenceValue": 100,
"returnCode": null,
"returnMessage": null,
"self": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/payments/34C219BBF1504A19B0608FB498A48B0B"
},
"sheets": null,
"status": "Received",
"tid": null,
"value": 100
},
"properties": {
"ConnectorResponses": {
"nullable": true,
"type": "string"
},
"ShowConnectorResponses": {
"type": "boolean"
},
"allowInstallments": {
"type": "boolean"
},
"allowIssuer": {
"type": "boolean"
},
"allowNotification": {
"type": "boolean"
},
"connector": {
"type": "string"
},
"connectorResponse": {
"nullable": true,
"type": "string"
},
"currencyCode": {
"nullable": true,
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"fields": {
"description": "",
"items": {
"$ref": "#/components/schemas/Fields1"
},
"type": "array"
},
"group": {
"type": "string"
},
"id": {
"type": "string"
},
"installments": {
"format": "int32",
"type": "integer"
},
"installmentsInterestRate": {
"format": "int32",
"type": "integer"
},
"installmentsValue": {
"format": "int32",
"type": "integer"
},
"isAvailable": {
"type": "boolean"
},
"isCustom": {
"type": "boolean"
},
"merchantName": {
"nullable": true,
"type": "string"
},
"paymentSystem": {
"format": "int32",
"type": "integer"
},
"paymentSystemName": {
"type": "string"
},
"provider": {
"nullable": true,
"type": "string"
},
"referenceValue": {
"format": "int32",
"type": "integer"
},
"returnCode": {
"nullable": true,
"type": "string"
},
"returnMessage": {
"nullable": true,
"type": "string"
},
"self": {
"$ref": "#/components/schemas/Self"
},
"sheets": {
"nullable": true,
"type": "string"
},
"status": {
"type": "string"
},
"tid": {
"nullable": true,
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"paymentSystem",
"paymentSystemName",
"merchantName",
"group",
"isCustom",
"allowInstallments",
"allowIssuer",
"allowNotification",
"isAvailable",
"description",
"self",
"tid",
"returnCode",
"returnMessage",
"status",
"connector",
"ConnectorResponses",
"connectorResponse",
"ShowConnectorResponses",
"value",
"installmentsInterestRate",
"installmentsValue",
"referenceValue",
"installments",
"currencyCode",
"provider",
"fields",
"sheets"
],
"title": "ReceivePaymentsResponse",
"type": "object"
},
"Refunds": {
"example": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/refunds"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Refunds",
"type": "object"
},
"RefundthetransactionRequest": {
"default": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"properties": {
"minicart": {
"default": {
"minicart": {
"freight": 200,
"items": [
{
"discount": 50,
"id": "122323",
"name": "Tenis Preto I",
"quantity": 1,
"shippingDiscount": 0,
"value": 1000
},
{
"discount": 50,
"id": "122324",
"name": "Tenis Nike Azul",
"quantity": 1,
"shippingDiscount": 0,
"value": 1100
}
],
"tax": 0
},
"value": 2300
},
"description": "This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/vtex-rest-api/reference/orders#getorder) or [Transaction Details](https://developers.vtex.com/vtex-rest-api/reference/transaction-process#transactiondetails) endpoints. It should only be included for transactions with split payment.",
"properties": {
"freight": {
"format": "int32",
"type": "integer"
},
"items": {
"items": {},
"type": "array"
},
"tax": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"value": {
"description": "Value of the purchase.",
"format": "int32",
"type": "integer"
}
},
"required": [
"value"
],
"title": "RefundthetransactionRequest",
"type": "object"
},
"Request": {
"example": {
"date": "2018-06-05T13:08:22",
"id": "AFB933448FFD4867BF82BCC7026A082C",
"value": 4499000
},
"properties": {
"date": {
"type": "string"
},
"id": {
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"date",
"value"
],
"title": "Request",
"type": "object"
},
"Rule": {
"example": {
"antifraudImplementation": null,
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PayPalPlusConnector",
"id": "2d062b92-f247-4935-a237-8e309e2b4422"
},
"properties": {
"antifraudImplementation": {
"nullable": true,
"type": "string"
},
"connectorImplementation": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"connectorImplementation",
"antifraudImplementation"
],
"title": "Rule",
"type": "object"
},
"RuleByIdRequest": {
"example": {
"antifraud": {
"affiliationId": "f952588c-8b41-41cc-a06f-c0f48f7320ef"
},
"beginDate": "0001-01-01T00:00:00",
"condition": null,
"connector": {
"affiliationId": "d0d7097e-0959-43dc-b335-852eda7b2992",
"implementation": "Vtex.PaymentGateway.Connectors.MundipaggConnector"
},
"country": null,
"dateIntervals": null,
"enabled": true,
"endDate": "9999-12-31T23:59:59.9999999",
"id": "eff4f368-b671-443b-b5a9-82616e87ea1c",
"installmentOptions": {
"interestRateMethod": null
},
"isDefault": null,
"isSelfAuthorized": null,
"issuer": {
"name": null
},
"multiMerchantList": null,
"name": "Visa gatewayqa",
"paymentSystem": {
"id": 2,
"implementation": null,
"name": "Visa"
},
"salesChannels": [
{
"id": "2"
}
]
},
"properties": {
"antifraud": {
"$ref": "#/components/schemas/Antifraud1"
},
"beginDate": {
"type": "string"
},
"condition": {
"nullable": true,
"type": "string"
},
"connector": {
"$ref": "#/components/schemas/Connector"
},
"country": {
"nullable": true,
"type": "string"
},
"dateIntervals": {
"nullable": true,
"type": "string"
},
"enabled": {
"type": "boolean"
},
"endDate": {
"type": "string"
},
"id": {
"type": "string"
},
"installmentOptions": {
"$ref": "#/components/schemas/InstallmentOptions"
},
"isDefault": {
"nullable": true,
"type": "string"
},
"isSelfAuthorized": {
"nullable": true,
"type": "string"
},
"issuer": {
"$ref": "#/components/schemas/Issuer"
},
"multiMerchantList": {
"nullable": true,
"type": "string"
},
"name": {
"type": "string"
},
"paymentSystem": {
"$ref": "#/components/schemas/PaymentSystem"
},
"salesChannels": {
"description": "",
"items": {
"$ref": "#/components/schemas/SalesChannel"
},
"type": "array"
}
},
"required": [
"id",
"name",
"salesChannels",
"paymentSystem",
"connector",
"issuer",
"antifraud",
"installmentOptions",
"isSelfAuthorized",
"enabled",
"isDefault",
"beginDate",
"endDate",
"condition",
"multiMerchantList",
"country",
"dateIntervals"
],
"title": "RuleByIdRequest",
"type": "object"
},
"SalesChannel": {
"example": {
"id": ":ALL:"
},
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"title": "SalesChannel",
"type": "object"
},
"Self": {
"example": {
"href": "/api/pvt/payment-systems/2"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Self",
"type": "object"
},
"SettleResponse": {
"example": {
"cancelledValue": 0,
"connectorRefundedValue": 0,
"message": null,
"processingDate": "2017-08-16T17:40:59.3043324Z",
"refundedToken": null,
"refundedValue": 0,
"status": 13,
"statusDetail": "Finished",
"token": "933276E993ED4452AE4CE2B9B5C6B2F4"
},
"properties": {
"cancelledValue": {
"format": "int32",
"type": "integer"
},
"connectorRefundedValue": {
"format": "int32",
"type": "integer"
},
"message": {
"nullable": true,
"type": "string"
},
"processingDate": {
"type": "string"
},
"refundedToken": {
"nullable": true,
"type": "string"
},
"refundedValue": {
"format": "int32",
"type": "integer"
},
"status": {
"format": "int32",
"type": "integer"
},
"statusDetail": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status",
"statusDetail",
"processingDate",
"refundedValue",
"refundedToken",
"message",
"connectorRefundedValue",
"cancelledValue"
],
"title": "SettleResponse",
"type": "object"
},
"Settlements": {
"example": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/settlements"
},
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
],
"title": "Settlements",
"type": "object"
},
"SettlethetransactionRequest": {
"example": {
"value": 100
},
"properties": {
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"value"
],
"title": "SettlethetransactionRequest",
"type": "object"
},
"StartTransactionResponse": {
"example": {
"acceptHeader": null,
"antifraudAffiliationId": null,
"antifraudTid": null,
"authorizationDate": null,
"authorizationToken": null,
"buyer": null,
"cancelationDate": null,
"cancelationToken": null,
"cancellations": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/cancellations"
},
"channel": "gatewayqa",
"commitmentDate": null,
"commitmentToken": null,
"fields": [
{
"name": "owner",
"value": "vtexappkey-appvtex"
},
{
"name": "channel",
"value": "gatewayqa"
},
{
"name": "salesChannel",
"value": "1"
}
],
"id": "85A3A4B536E64C108FB941CC3CF5A9A1",
"interactions": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/interactions"
},
"ipAddress": null,
"markedForRecurrence": false,
"owner": "vtexappkey-appvtex",
"payments": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/payments"
},
"receiverUri": "https://gatewayqa.vtexpayments.com.br/split/85A3A4B536E64C108FB941CC3CF5A9A1/payments",
"referenceKey": "1234567",
"refundingDate": null,
"refundingToken": null,
"refunds": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/refunds"
},
"salesChannel": "1",
"settlements": {
"href": "/api/pvt/transactions/85A3A4B536E64C108FB941CC3CF5A9A1/settlements"
},
"softDescriptor": null,
"startDate": "2016-04-15T02:52:24.3801586Z",
"status": "Started",
"timeoutStatus": 0,
"totalRefunds": 0,
"transactionId": "85A3A4B536E64C108FB941CC3CF5A9A1",
"urn": null,
"userAgent": null,
"value": 100
},
"properties": {
"acceptHeader": {
"nullable": true,
"type": "string"
},
"antifraudAffiliationId": {
"nullable": true,
"type": "string"
},
"antifraudTid": {
"nullable": true,
"type": "string"
},
"authorizationDate": {
"nullable": true,
"type": "string"
},
"authorizationToken": {
"nullable": true,
"type": "string"
},
"buyer": {
"nullable": true,
"type": "string"
},
"cancelationDate": {
"nullable": true,
"type": "string"
},
"cancelationToken": {
"nullable": true,
"type": "string"
},
"cancellations": {
"$ref": "#/components/schemas/Cancellations"
},
"channel": {
"type": "string"
},
"commitmentDate": {
"nullable": true,
"type": "string"
},
"commitmentToken": {
"nullable": true,
"type": "string"
},
"fields": {
"description": "",
"items": {
"$ref": "#/components/schemas/Field"
},
"type": "array"
},
"id": {
"type": "string"
},
"interactions": {
"$ref": "#/components/schemas/Interactions"
},
"ipAddress": {
"nullable": true,
"type": "string"
},
"markedForRecurrence": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"payments": {
"$ref": "#/components/schemas/Payments"
},
"receiverUri": {
"type": "string"
},
"referenceKey": {
"type": "string"
},
"refundingDate": {
"nullable": true,
"type": "string"
},
"refundingToken": {
"nullable": true,
"type": "string"
},
"refunds": {
"$ref": "#/components/schemas/Refunds"
},
"salesChannel": {
"type": "string"
},
"settlements": {
"$ref": "#/components/schemas/Settlements"
},
"softDescriptor": {
"nullable": true,
"type": "string"
},
"startDate": {
"type": "string"
},
"status": {
"type": "string"
},
"timeoutStatus": {
"format": "int32",
"type": "integer"
},
"totalRefunds": {
"type": "number"
},
"transactionId": {
"type": "string"
},
"urn": {
"nullable": true,
"type": "string"
},
"userAgent": {
"nullable": true,
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"transactionId",
"referenceKey",
"interactions",
"settlements",
"payments",
"refunds",
"cancellations",
"timeoutStatus",
"totalRefunds",
"status",
"value",
"receiverUri",
"startDate",
"authorizationToken",
"authorizationDate",
"commitmentToken",
"commitmentDate",
"refundingToken",
"refundingDate",
"cancelationToken",
"cancelationDate",
"fields",
"ipAddress",
"owner",
"userAgent",
"acceptHeader",
"antifraudTid",
"antifraudAffiliationId",
"channel",
"salesChannel",
"urn",
"softDescriptor",
"markedForRecurrence",
"buyer"
],
"title": "StartTransactionResponse",
"type": "object"
},
"Transaction": {
"example": {
"id": "{{transactionId}}",
"merchantName": "{{accountName}}"
},
"properties": {
"id": {
"type": "string"
},
"merchantName": {
"type": "string"
}
},
"required": [
"id",
"merchantName"
],
"title": "Transaction",
"type": "object"
},
"TransactionDetailsResponse": {
"example": {
"acceptHeader": "application/json",
"antifraudAffiliationId": null,
"antifraudTid": null,
"authorizationDate": null,
"authorizationToken": null,
"buyer": null,
"cancelationDate": null,
"cancelationToken": null,
"cancellations": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/cancellations"
},
"channel": "gatewayqa",
"commitmentDate": null,
"commitmentToken": null,
"fields": [
{
"name": "owner",
"value": "vtexappkey-appvtex"
},
{
"name": "channel",
"value": "gatewayqa"
},
{
"name": "salesChannel",
"value": "1"
},
{
"name": "markedForRecurrence",
"value": "true"
},
{
"name": "parentMerchant",
"value": "648a4ce7-c16d-4fba-9854-072384636a32"
},
{
"name": "orderId",
"value": "1234567"
},
{
"name": "ip",
"value": "10.0.4.12"
},
{
"name": "userAgent",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36"
},
{
"name": "acceptHeader",
"value": "application/json"
},
{
"name": "cart",
"value": "{\"items\":[\r\n {\r\n \"id\":\"122323\",\r\n \"name\":\"Tenis Preto I\",\r\n \"value\":1000,\r\n \"quantity\":1,\r\n \"shippingDiscount\":0,\r\n \"discount\":50\r\n },\r\n {\r\n \"id\":\"122324\",\r\n \"name\":\"Tenis Nike Azul\",\r\n \"value\":1100,\r\n \"quantity\":1,\r\n \"shippingDiscount\":0,\r\n \"discount\":50\r\n }\r\n ],\"freight\":200,\r\n \"tax\":0\r\n }"
},
{
"name": "clientProfileData",
"value": "{\"email\":\"teste@teste.com\",\"firstName\":\"Joao\",\"lastName\":\"Baptista\",\"document\":\"06134240040\",\"phone\":\"+551433118100\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"postalCode\":\"22011-050\",\"address\":{\"receiverName\":\"Ellen\",\"postalCode\":\"22011050\",\"city\":\"RIO DE JANEIRO\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"RUA GENERAL AZEVEDO PIMENTEL\",\"number\":\"12345\",\"neighborhood\":\"COPACABANA\",\"complement\":\"APTO 302\",\"reference\":null},\"gender\":null,\"birthDate\":null,\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":null,\"isFirstPurchase\":false,\"id\":null}"
},
{
"name": "shippingData",
"value": "{\"receiverName\":\"Rodrigo Saens\",\"postalCode\":\"65035430\",\"city\":\"SAO LUIS\",\"state\":\"MA\",\"country\":\"BRA\",\"street\":\"AV NEWTON \",\"number\":\"321\",\"neighborhood\":\"MONTE CATELO\",\"complement\":\"APTO 102\",\"reference\":null}"
}
],
"id": "A3BDE325F76B4B758B398D900DF06150",
"interactions": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/interactions"
},
"ipAddress": "10.0.4.12",
"markedForRecurrence": true,
"owner": "vtexappkey-appvtex",
"payments": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/payments"
},
"receiverUri": null,
"referenceKey": "1234567",
"refundingDate": null,
"refundingToken": null,
"refunds": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/refunds"
},
"salesChannel": "1",
"settlements": {
"href": "/api/pvt/transactions/A3BDE325F76B4B758B398D900DF06150/settlements"
},
"softDescriptor": null,
"startDate": "2016-04-15T02:36:38",
"status": "Cancelling",
"timeoutStatus": 2,
"totalRefunds": 0,
"transactionId": "A3BDE325F76B4B758B398D900DF06150",
"urn": null,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36",
"value": 100
},
"properties": {
"acceptHeader": {
"type": "string"
},
"antifraudAffiliationId": {
"nullable": true,
"type": "string"
},
"antifraudTid": {
"nullable": true,
"type": "string"
},
"authorizationDate": {
"nullable": true,
"type": "string"
},
"authorizationToken": {
"nullable": true,
"type": "string"
},
"buyer": {
"nullable": true,
"type": "string"
},
"cancelationDate": {
"nullable": true,
"type": "string"
},
"cancelationToken": {
"nullable": true,
"type": "string"
},
"cancellations": {
"$ref": "#/components/schemas/Cancellations"
},
"channel": {
"type": "string"
},
"commitmentDate": {
"nullable": true,
"type": "string"
},
"commitmentToken": {
"nullable": true,
"type": "string"
},
"fields": {
"description": "",
"items": {
"$ref": "#/components/schemas/Fields1"
},
"type": "array"
},
"id": {
"type": "string"
},
"interactions": {
"$ref": "#/components/schemas/Interactions"
},
"ipAddress": {
"type": "string"
},
"markedForRecurrence": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"payments": {
"$ref": "#/components/schemas/Payments"
},
"receiverUri": {
"nullable": true,
"type": "string"
},
"referenceKey": {
"type": "string"
},
"refundingDate": {
"nullable": true,
"type": "string"
},
"refundingToken": {
"nullable": true,
"type": "string"
},
"refunds": {
"$ref": "#/components/schemas/Refunds"
},
"salesChannel": {
"type": "string"
},
"settlements": {
"$ref": "#/components/schemas/Settlements"
},
"softDescriptor": {
"nullable": true,
"type": "string"
},
"startDate": {
"type": "string"
},
"status": {
"type": "string"
},
"timeoutStatus": {
"format": "int32",
"type": "integer"
},
"totalRefunds": {
"type": "number"
},
"transactionId": {
"type": "string"
},
"urn": {
"nullable": true,
"type": "string"
},
"userAgent": {
"type": "string"
},
"value": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"transactionId",
"referenceKey",
"interactions",
"settlements",
"payments",
"refunds",
"cancellations",
"timeoutStatus",
"totalRefunds",
"status",
"value",
"receiverUri",
"startDate",
"authorizationToken",
"authorizationDate",
"commitmentToken",
"commitmentDate",
"refundingToken",
"refundingDate",
"cancelationToken",
"cancelationDate",
"fields",
"ipAddress",
"owner",
"userAgent",
"acceptHeader",
"antifraudTid",
"antifraudAffiliationId",
"channel",
"salesChannel",
"urn",
"softDescriptor",
"markedForRecurrence",
"buyer"
],
"title": "TransactionDetailsResponse",
"type": "object"
},
"TransactionSettlementDetails": {
"example": {
"actions": [
{
"connectorResponse": null,
"date": "2018-06-05T12:55:58.6262759Z",
"payment": {
"href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE"
},
"paymentId": "87055E7199A446519EB07F1243D5B8BE",
"type": "auto-settlement",
"value": 4499000
}
],
"requests": [
{
"date": "2018-06-05T13:08:22",
"id": "AFB933448FFD4867BF82BCC7026A082C",
"value": 4499000
}
]
},
"properties": {
"actions": {
"description": "",
"items": {
"$ref": "#/components/schemas/Action"
},
"type": "array"
},
"requests": {
"description": "",
"items": {
"$ref": "#/components/schemas/Request"
},
"type": "array"
}
},
"required": [
"requests",
"actions"
],
"title": "TransactionSettlementDetails",
"type": "object"
},
"UpdateAffiliationRequest": {
"example": {
"configuration": [
{
"name": "HowTo",
"value": "https://developercielo.github.io/Habilitacao-meios-de-pagamento/"
},
{
"name": "MerchantId",
"value": "DATA TEST"
},
{
"name": "MerchantKey",
"value": "DATA TEST"
},
{
"name": "softDescriptor",
"value": "teste"
},
{
"name": "bankInvoiceProvider",
"value": "Disabled"
},
{
"name": "bankIDebitProvider",
"value": "Disabled"
},
{
"name": "useEarlySecurityCapture",
"value": "0"
},
{
"name": "isProduction",
"value": "false"
},
{
"name": "bankDebitProvider",
"value": "Disabled"
},
{
"name": "Registered",
"value": "false"
}
],
"id": "61c3b25b-554d-41a4-b989-a0ba215e4bba",
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"isConfigured": true,
"isdelivered": true,
"name": "CieloV3 - Teste Ellen"
},
"properties": {
"configuration": {
"description": "",
"items": {
"$ref": "#/components/schemas/Configuration"
},
"type": "array"
},
"id": {
"type": "string"
},
"implementation": {
"type": "string"
},
"isConfigured": {
"type": "boolean"
},
"isdelivered": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"implementation",
"name",
"configuration",
"isdelivered",
"isConfigured"
],
"title": "UpdateAffiliationRequest",
"type": "object"
},
"ValidRequest": {
"example": {
"installments": [
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 2,
"isDefault": false,
"name": "ERedeV2 - Nova Visa",
"self": {
"href": "/api/pvt/payment-systems/2"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 3,
"isDefault": false,
"name": "ERedeV2 - Nova Diners",
"self": {
"href": "/api/pvt/payment-systems/3"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 4,
"isDefault": false,
"name": "ERedeV2 - Nova Mastercard",
"self": {
"href": "/api/pvt/payment-systems/4"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 6,
"isDefault": false,
"name": "Boleto Bancário - WEG79AKC8R529",
"self": {
"href": "/api/pvt/payment-systems/6"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 7,
"isDefault": false,
"name": "ERedeV2 - Nova Aura",
"self": {
"href": "/api/pvt/payment-systems/7"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 8,
"isDefault": false,
"name": "Hipercard - CNRYOV0ANPZAOR",
"self": {
"href": "/api/pvt/payment-systems/8"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
},
{
"interestRate": 0,
"quantity": 2,
"value": 5
}
],
"payment": {
"bin": null,
"id": 9,
"isDefault": false,
"name": "Elo/Mundipagg",
"self": {
"href": "/api/pvt/payment-systems/9"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 12,
"isDefault": false,
"name": "PayPal - 6U0DTI3M3OKO6R",
"self": {
"href": "/api/pvt/payment-systems/12"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 16,
"isDefault": false,
"name": "Vale/GiftCard",
"self": {
"href": "/api/pvt/payment-systems/16"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
},
{
"interestRate": 0,
"quantity": 2,
"value": 5
},
{
"interestRate": 0,
"quantity": 3,
"value": 3.33
}
],
"payment": {
"bin": null,
"id": 18,
"isDefault": false,
"name": "Mercado Pago - XBKAG5IMTJRA4I",
"self": {
"href": "/api/pvt/payment-systems/18"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 26,
"isDefault": false,
"name": "PagSeguro - HRXC4VO76NU3DI",
"self": {
"href": "/api/pvt/payment-systems/26"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 33,
"isDefault": false,
"name": "ERedeV2 - Nova Cabal",
"self": {
"href": "/api/pvt/payment-systems/33"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 38,
"isDefault": false,
"name": "Safetypay - Q8J8XIXDSSPDS4I",
"self": {
"href": "/api/pvt/payment-systems/38"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 43,
"isDefault": false,
"name": "PagosWeb - PDA8UKCUTMX6R",
"self": {
"href": "/api/pvt/payment-systems/43"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 49,
"isDefault": false,
"name": "PayPalPlus - LW5HDKPMD3G14I",
"self": {
"href": "/api/pvt/payment-systems/49"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430004,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430004"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430014,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430014"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430201,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430201"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430202,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430202"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430203,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430203"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430208,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430208"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430210,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430210"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430220,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430220"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430222,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430222"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430230,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430230"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430231,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430231"
},
"value": 10
}
},
{
"options": [
{
"interestRate": 0,
"quantity": 1,
"value": 10
}
],
"payment": {
"bin": null,
"id": 430232,
"isDefault": false,
"name": null,
"self": {
"href": "/api/pvt/payment-systems/430232"
},
"value": 10
}
}
],
"value": 10
},
"properties": {
"installments": {
"description": "",
"items": {
"$ref": "#/components/schemas/Installment"
},
"type": "array"
},
"value": {
"type": "number"
}
},
"required": [
"value",
"installments"
],
"title": "ValidRequest",
"type": "object"
},
"Validator": {
"example": {
"cardCodeMask": null,
"cardCodeRegex": null,
"mask": null,
"regex": null,
"useBillingAddress": false,
"useCardHolderName": false,
"useCvv": false,
"useExpirationDate": false,
"validCardLengths": null,
"weights": null
},
"properties": {
"cardCodeMask": {
"nullable": true,
"type": "string"
},
"cardCodeRegex": {
"nullable": true,
"type": "string"
},
"mask": {
"nullable": true,
"type": "string"
},
"regex": {
"nullable": true,
"type": "string"
},
"useBillingAddress": {
"type": "boolean"
},
"useCardHolderName": {
"type": "boolean"
},
"useCvv": {
"type": "boolean"
},
"useExpirationDate": {
"type": "boolean"
},
"validCardLengths": {
"nullable": true,
"type": "string"
},
"weights": {
"description": "",
"items": {
"format": "int32",
"type": "integer"
},
"nullable": true,
"type": "array"
}
},
"required": [
"regex",
"mask",
"cardCodeMask",
"cardCodeRegex",
"weights",
"useCvv",
"useExpirationDate",
"useCardHolderName",
"useBillingAddress",
"validCardLengths"
],
"title": "Validator",
"type": "object"
}
},
"securitySchemes": {
"appKey": {
"in": "header",
"name": "X-VTEX-API-AppKey",
"type": "apiKey"
},
"appToken": {
"in": "header",
"name": "X-VTEX-API-AppToken",
"type": "apiKey"
}
}
}
}