openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Transaction Process API 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 Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: Transaction Process paths: /api/pvt/transactions: post: tags: - Transaction Process summary: VTex 1. Start a new transaction description: "This request is the first step to create a new transaction.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: 1.Createanewtransaction parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/1.CreateanewtransactionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StartTransactionResponse' example: id: 46351F157C624CBA926359ADED377265 transactionId: 46351F157C624CBA926359ADED377265 referenceKey: '1234567' interactions: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/interactions settlements: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/settlements payments: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/payments refunds: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/refunds cancellations: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/cancellations capabilities: href: /api/pvt/transactions/46351F157C624CBA926359ADED377265/capabilities timeoutStatus: 0 totalRefunds: 0 status: Started value: 20000 receiverUri: https://cosmetics2.vtexpayments.com.br/split/46351F157C624CBA926359ADED377265/payments startDate: '2023-12-15T19:53:59.4307279Z' authorizationToken: null authorizationDate: null commitmentToken: null commitmentDate: null refundingToken: null refundingDate: null cancelationToken: null cancelationDate: null fields: - name: owner value: teste_1@test.com - name: lastTransitionDate value: 12/15/2023 7:53:59 PM - name: TotalTimeSpentInTransitionsUntilThisTransition value: '0' - name: channel value: cosmetics2 - name: salesChannel value: '1' ipAddress: null sessionId: null macId: null vtexFingerprint: null chargeback: null whiteSignature: null owner: teste_1@test.com orderId: null userAgent: null acceptHeader: null antifraudTid: null antifraudResponse: null antifraudReference: null antifraudAffiliationId: null channel: cosmetics2 salesChannel: '1' urn: null softDescriptor: null markedForRecurrence: false buyer: null deprecated: false /api/pub/transactions/{transactionId}/payments: post: tags: - Transaction Process summary: VTex 2.1 Send payments information public description: "The second step to create a new transaction. This request is used to send the payment data through a public request.\r\n>\r\n>ℹ️ If you want to send payment data containing sensitive information, such as credit card data, use the [Send payments with saved credit card](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/payments) endpoint.## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)." operationId: 2.SendPaymentsPublic parameters: - name: orderId in: query description: Order identification. required: true style: form explode: true schema: type: string example: '1248716513905' - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/2.SendPaymentsPublicRequest' description: Payment information. responses: '201': description: Created. This endpoint does not return any data in the response body. deprecated: false /api/pvt/transactions/{transactionId}/payments: post: tags: - Transaction Process summary: VTex 2.2 Send payments with saved credit card description: "The second step to create a new transaction. This request is used to send the payment data through a private request.\r\n>\r\n>ℹ️ If you want to send payment data that does not contain sensitive information, you can use the [Send payments information public](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pub/transactions/-transactionId-/payments) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: 2.SendPaymentsWithSavedCreditCard parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/2.SendPaymentsWithSavedCreditCardRequest' description: Payment information. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentDetailsResponse' example: id: 1EED2BE7683644B4B4D441B0AFCE4004 paymentSystem: 4 paymentSystemName: Mastercard merchantName: null group: creditCard userProfileId: null isCustom: false allowInstallments: true requiresAuthentication: false allowIssuer: true allowNotification: false isAvailable: true description: null authorizationDate: null self: href: /api/pvt/transactions/99129781C2D84F2AA55E62B72B14A7E9/payments/1EED2BE7683644B4B4D441B0AFCE4004 tid: null nsu: null returnCode: null returnMessage: null status: Received connector: null ConnectorResponses: null connectorResponse: null ShowConnectorResponses: false value: 30000 installmentsInterestRate: 0 installmentsValue: 0 referenceValue: 30000 installments: 1 currencyCode: BRL provider: null isBillingAddressDifferent: null isRegexValid: null isLuhnValid: null fields: - name: AvailableRules value: 993d4d35-b64d-454d-8108-c560580160e0,eae3d89b-7dc7-4862-931d-e6d4e1ff838c - name: originalPaymentSystem value: '4' - name: baseUrl value: https://cosmetics2.vtexpayments.com.br:443 - name: currencyCode value: BRL - name: usedAccountId value: 'False' - name: cardHolder value: UserTest - name: firstDigits value: '537824' - name: lastDigits value: '9174' - name: expiryMonth value: '10' - name: expiryYear value: '2019' - name: accountId value: 09F1F6C21F764BBF85D0039F4A2D3E04 sheets: null originalPaymentId: null deprecated: false /api/pvt/transactions/{transactionId}/additional-data: post: tags: - Transaction Process summary: VTex 3. Send additional data description: "The third step to create a new transaction. This request sends additional data related to the transaction, such as profile information, shopping cart, shipping data, among others.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: 3.SendAdditionalData parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: array description: Array containing additional data. items: type: object description: Additional data fields. required: - name - value properties: name: type: string description: Dataset name. This information must be sent in escaped JSON format. value: type: string description: Dataset values. This information must be sent in escaped JSON format. example: - name: cart value: '{"items":[{"id":"6257034","name":"Tamanco Couro Preto Poá","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"C503YC002_34","productId":"6257000","sellingPrice":59.99,"sellerId":"1","dockId":"999800000-5","categoryId":"18","categoryName":"Tamanco","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":167},{"id":"7136034","name":"Sandália Off White Espadrile Salto Forrado","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S5146R881_34","productId":"7136000","sellingPrice":59.99,"sellerId":"1","dockId":"999800000-5","categoryId":"12","categoryName":"Anabela","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":166},{"id":"8305038","name":"Tamanco Caramelo Salto Fachete","value":9999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S534IZ012_38","productId":"8305000","sellingPrice":99.99,"sellerId":"1","dockId":"999800000-5","categoryId":"18","categoryName":"Tamanco","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":166},{"id":"7641034","name":"Tênis Slip On Couro Preto Recorte","value":9999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"C524B9002_34","productId":"7641000","sellingPrice":99.99,"sellerId":"coinshop","dockId":"0405","categoryId":"30","categoryName":"Clássico","deliveryChannel":"delivery","deliveryType":"Correios - PAC","deliverySlaInMinutes":18720,"deliveryWindow":null,"tax":0,"freight":7138},{"id":"8278038","name":"Tênis Slip Caramelo Matelassê","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S534IR012_38","productId":"8278000","sellingPrice":59.99,"sellerId":"coinmarket","dockId":"0571","categoryId":"32","categoryName":"Slip On","deliveryChannel":"delivery","deliveryType":"PAC","deliverySlaInMinutes":14400,"deliveryWindow":null,"tax":0,"freight":7090}],"sellers":[{"id":"1","name":"CONSTANCE","documentType":"CNPJ","document":"30901791000191"},{"id":"coinshop","name":"coinshop","documentType":"CNPJ","document":"48275547000126"},{"id":"coinmarket","name":"coinmarket","documentType":"CNPJ","document":"48314133000169"}],"freight":14727,"shippingdate":null,"shippingestimated":"4bd","orderUrl":"http://www.constance.com.br/admin/checkout/#/orders?q=1373160984904","tax":0,"isGiftRegistry":null,"giftRegistryDescription":null,"giftRegistryId":null,"isPickupStore":null,"isCallCenter":null}' - name: clientProfileData value: '{"email":"test@test.com","firstName":"Izidio","lastName":"Test Trace","document":"111111111","phone":"+56987654321","corporateName":null,"tradeName":null,"corporateDocument":null,"stateInscription":"Exento","postalCode":"8320000","address":{"receiverName":"wqqw weqw","postalCode":"8320000","city":"wdade","state":"Región Metropolitana","country":"CHL","street":"asdafd","number":"sadas","neighborhood":"Santiago","complement":"604","reference":"efa"},"gender":null,"birthDate":null,"createdDate":null,"corporatePhone":null,"isCorporate":false,"documentType":"rutCHL","id":"d48a1cd3-c04e-4949-a275-df4b197a7ec9"}' responses: '200': description: OK. This endpoint does not return any data in the response body. deprecated: false patch: tags: - Transaction Process summary: VTex 3.1 Update additional data (optional) description: "Use this request to update any information that has previously been sent on endpoint [3. Send additional data](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/additional-data).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: 3.1UpdateAdditionalData parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: array description: Array containing additional data. items: type: object description: Additional data fields. required: - name - value properties: name: type: string description: Dataset name. This information must be sent in escaped JSON format. value: type: string description: Dataset values. This information must be sent in escaped JSON format. example: - name: cart value: '{"items":[{"id":"6257034","name":"Tamanco Couro Preto Poá","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"C503YC002_34","productId":"6257000","sellingPrice":59.99,"sellerId":"1","dockId":"999800000-5","categoryId":"18","categoryName":"Tamanco","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":167},{"id":"7136034","name":"Sandália Off White Espadrile Salto Forrado","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S5146R881_34","productId":"7136000","sellingPrice":59.99,"sellerId":"1","dockId":"999800000-5","categoryId":"12","categoryName":"Anabela","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":166},{"id":"8305038","name":"Tamanco Caramelo Salto Fachete","value":9999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S534IZ012_38","productId":"8305000","sellingPrice":99.99,"sellerId":"1","dockId":"999800000-5","categoryId":"18","categoryName":"Tamanco","deliveryChannel":"delivery","deliveryType":"Convencional","deliverySlaInMinutes":5760,"deliveryWindow":null,"tax":0,"freight":166},{"id":"7641034","name":"Tênis Slip On Couro Preto Recorte","value":9999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"C524B9002_34","productId":"7641000","sellingPrice":99.99,"sellerId":"coinshop","dockId":"0405","categoryId":"30","categoryName":"Clássico","deliveryChannel":"delivery","deliveryType":"Correios - PAC","deliverySlaInMinutes":18720,"deliveryWindow":null,"tax":0,"freight":7138},{"id":"8278038","name":"Tênis Slip Caramelo Matelassê","value":5999,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":"S534IR012_38","productId":"8278000","sellingPrice":59.99,"sellerId":"coinmarket","dockId":"0571","categoryId":"32","categoryName":"Slip On","deliveryChannel":"delivery","deliveryType":"PAC","deliverySlaInMinutes":14400,"deliveryWindow":null,"tax":0,"freight":7090}],"sellers":[{"id":"1","name":"CONSTANCE","documentType":"CNPJ","document":"30901791000191"},{"id":"coinshop","name":"coinshop","documentType":"CNPJ","document":"48275547000126"},{"id":"coinmarket","name":"coinmarket","documentType":"CNPJ","document":"48314133000169"}],"freight":14727,"shippingdate":null,"shippingestimated":"4bd","orderUrl":"http://www.constance.com.br/admin/checkout/#/orders?q=1373160984904","tax":0,"isGiftRegistry":null,"giftRegistryDescription":null,"giftRegistryId":null,"isPickupStore":null,"isCallCenter":null}' - name: clientProfileData value: '{"email":"test@test.com","firstName":"Izidio","lastName":"Test Trace","document":"111111111","phone":"+56987654321","corporateName":null,"tradeName":null,"corporateDocument":null,"stateInscription":"Exento","postalCode":"8320000","address":{"receiverName":"wqqw weqw","postalCode":"8320000","city":"wdade","state":"Región Metropolitana","country":"CHL","street":"asdafd","number":"sadas","neighborhood":"Santiago","complement":"604","reference":"efa"},"gender":null,"birthDate":null,"createdDate":null,"corporatePhone":null,"isCorporate":false,"documentType":"rutCHL","id":"d48a1cd3-c04e-4949-a275-df4b197a7ec9"}' responses: '200': description: OK. This endpoint does not return any data in the response body. deprecated: false /api/pvt/transactions/{transactionId}/authorization-request: post: tags: - Transaction Process summary: VTex 4. Authorize new transaction description: "The fourth and last step to create a new transaction. It will authorized the new transaction creation according to the data previously informed in the latests requests.\r\n\r\nThis step is the trigger to process each of payments that were received in step 2.\r\n\r\nEach payment will be sent to acquirer. If all payments are authorized, the transaction will be authorized. If one of the payments is denied, all payments in transaction will be cancelled.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: 4.Doauthorization parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/4.DoauthorizationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SettleResponse' example: id: null token: 2BCA48B4FBCB42D0B8A19EE965712AD8 status: 8 statusDetail: Approved processingDate: '2023-12-14T22:45:50.9977213Z' refundedValue: 0 refundedToken: null message: null code: null connectorRefundedValue: 0 cancelledValue: 0 deprecated: false /api/pvt/transactions/{transactionId}: get: tags: - Transaction Process summary: VTex Get transaction details description: "Returns data about a specific transaction made in your store.\r\n\r\n>⚠️ Do not use the `interactions.href` route which is part of this endpoint's response. This is an internal-only route not meant to be used by external developers.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: TransactionDetails parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionDetailsResponse' example: id: D3640578F8124C50CB42BD3F8D282CD9 transactionId: D3640578F8124C50CB42BD3F8D282CD9 referenceKey: '505288' interactions: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/interactions settlements: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/settlements payments: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/payments refunds: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/refunds cancellations: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/cancellations capabilities: href: /api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/capabilities timeoutStatus: 0 totalRefunds: 0 status: Finished value: 61400 receiverUri: null startDate: '2023-06-02T17:04:19' authorizationToken: 0C825428F9804701A8DCF2BE9E0968C4 authorizationDate: '2023-06-02T17:04:24' commitmentToken: 1E25BAB9A8F84DBC8A5E4AC26A0A534H commitmentDate: '2023-06-02T17:05:44' refundingToken: null refundingDate: null cancelationToken: null cancelationDate: null fields: - name: owner value: vtexappkey-appvtex - name: conditions value: '[{"id":"1","value":609.0}]' - name: postbackStatusUrl value: https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1336650505288/notifications/transaction-status?an=cosmetics2 - name: shopperInteraction value: ecommerce - name: lastTransitionDate value: 6/2/2023 5:05:44 PM - name: TotalTimeSpentInTransitionsUntilThisTransition value: '87581.1868' - name: channel value: COSMETICS2 - name: salesChannel value: '1' - name: parentMerchant value: a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2 - name: orderId value: '1336650505288' - name: ip value: 152.248.55.27 - name: sessionId value: 09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0 - name: macId value: 89314737-9d03-4607-9814-61ed1a59b0bd - name: userAgent value: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36 - name: acceptHeader value: application/json,text/plain,*/* - name: deviceInfo value: '{"screenWidth":1920,"screenHeight":1080,"colorDepth":24,"timeZoneOffset":180,"language":"en","javaEnabled":false,"acceptHeader":"application/json,text/plain,*/*","userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36","ipAddress":"152.248.55.27","sourceApplication":"vcs.checkout-ui@v6.83.1","installedApplications":["payment-provider","adyen-authentication-app","cielo-authentication-app","pix-payment","google-pay-payment-authorization-app","apple-pay-payment-authorization-app"]}' - name: cart value: '{"items":[{"id":"9","name":"Matcha Butter Conditioning Mask 100 ml","value":60900,"quantity":1,"priceTags":[],"components":null,"commission":0.0,"freightCommission":0.0,"sellerChain":null,"shippingDiscount":0,"discount":0,"refId":null,"productId":"4","sellingPrice":609.0,"sellerId":"vtxfqw4064","dockId":"doca_principal","categoryId":"1","categoryName":"Treatments","deliveryChannel":"delivery","deliveryType":"Normal","deliverySlaInMinutes":4320,"deliveryWindow":null,"tax":0,"freight":500}],"sellers":[{"id":"vtxfqw4064","name":"「ホワイトレーベル」ヴィトルのショップ","documentType":"CNPJ","document":null}],"freight":500,"shippingdate":null,"shippingestimated":"3bd","orderUrl":"http://vtexdayhackaton--cosmetics2.myvtex.com/admin/checkout/#/orders?q=1336650505288","tax":0,"isGiftRegistry":null,"giftRegistryDescription":null,"giftRegistryId":null,"isPickupStore":null,"isCallCenter":null}' - name: clientProfileData value: '{"email":"teste@teste.com","firstName":"teste","lastName":"teste","document":"01234567890","phone":"+5511999999999","corporateName":null,"tradeName":null,"corporateDocument":null,"stateInscription":null,"postalCode":"22250-040","address":{"receiverName":"test","postalCode":"22250040","city":"Rio de Janeiro","state":"RJ","country":"BRA","street":"Praia Botafogo","number":"123","neighborhood":"Botafogo","complement":null,"reference":null},"gender":null,"birthDate":null,"createdDate":"2023-06-01T03:09:50.408969Z","corporatePhone":null,"isCorporate":false,"documentType":"cpf","id":"db324ab8-fd91-40b3-b31f-c63b3b602495"}' - name: shippingData value: '{"receiverName":"test","postalCode":"22250040","city":"Rio de Janeiro","state":"RJ","country":"BRA","street":"Praia Botafogo","number":"123","neighborhood":"Botafogo","complement":null,"reference":null}' - name: retainPartialSettlements value: 'False' shopperInteraction: ecommerce ipAddress: 152.248.55.27 sessionId: 09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0 macId: 89314737-9d03-4607-9814-61ed1a59b0bd vtexFingerprint: null chargeback: null whiteSignature: null owner: vtexappkey-appvtex orderId: '1336650505288' userAgent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Safari/605.1.15 acceptHeader: application/json,text/plain,*/* antifraudTid: null antifraudResponse: null antifraudReference: null antifraudAffiliationId: null channel: COSMETICS2 salesChannel: '1' urn: null softDescriptor: company_name_description_code markedForRecurrence: false buyer: firstName: HUXXXXX lastName: PERXXXX documentType: cpf document: 169XXXXX718 email: test@test.com address: BRA 2163XXXXXXXXzile 58 phone: 219XXXX695 deprecated: false /api/pvt/transactions/{transactionId}/payments/{paymentId}: get: tags: - Transaction Process summary: VTex Get payment details description: "Returns data about a specific payment made in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: PaymentDetails parameters: - $ref: '#/components/parameters/transactionId' - name: paymentId in: path description: Payment identification. required: true style: simple schema: type: string example: B2E754DCD7304D22866CB6F221CF0FEB - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentDetailsResponse' example: id: 20147A81H48B64D8DA1423AFD32D6671C paymentSystem: 2 paymentSystemName: Visa merchantName: null group: creditCard userProfileId: null isCustom: false allowInstallments: true requiresAuthentication: false allowIssuer: true allowNotification: false isAvailable: true description: null authorizationDate: '2023-06-02T17:04:23' self: href: /api/pvt/transactions/D8640778F8194C50BB42BD4F9D282AD8/payments/20147A81H48B64D8DA1423AFD32D6671C tid: pi_3NEbOkCp13eGpuNm179AVYJ5 nsu: null returnCode: null returnMessage: null status: Finished connector: payment-test-v1 ConnectorResponses: Tid: pi_3NEbOkCp13eGpuNm172AVYJ4 ReturnCode: null Message: null authId: kh07vt nsu: p0dug1 connectorResponse: Tid: pi_3NEbOkCp13eGpuNm172AVYJ4 ReturnCode: null Message: null authId: kh07vt nsu: p0dug1 ShowConnectorResponses: true value: 61400 installmentsInterestRate: 0 installmentsValue: 61400 referenceValue: 61400 installments: 1 currencyCode: BRL provider: null isBillingAddressDifferent: false isRegexValid: null isLuhnValid: null fields: - name: AvailableRules value: 74410430-43b4-4b40-99f4-887f18f945dd,dc47c1f5-6950-4e38-b3af-1f56fc56ddd9,52e7e8ff-8508-4ac4-a78a-c5ddb054a0ee - name: originalPaymentSystem value: '2' - name: callbackUrl value: https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success - name: baseUrl value: https://payment-test.vtexpayments.com.br:443 - name: currencyCode value: BRL - name: usedAccountId value: 'True' - name: cardHolder value: teste teste - name: firstDigits value: '400000' - name: lastDigits value: '0002' - name: expiryMonth value: '05' - name: expiryYear value: '2038' - name: parentAccountId value: 08134AF761A148B9A5DCE14A81F31DD9 - name: accountId value: 08134AF761A148B9A5DCE14A81F31DD9 - name: address value: '{"addressType":"residential","addressId":"8427936352555","postalCode":"22250040","street":"Praia Botafogo","neighborhood":"Botafogo","city":"Rio de Janeiro","state":"RJ","country":"BRA","number":"123","complement":null}' - name: affiliationId value: 4696dd94-a6c2-4206-a90e-6348d7fb8a97 - name: ruleId value: 74450431-23b4-4b40-99f4-887f18f945dd - name: ruleName value: payment test - name: sequence value: 505288-0 - name: paymentMethod value: Visa - name: authorizationConnectorResponse value: '{"paymentId":"20147A81H48B64D8DA1423AFD32D6671C","status":"approved","acquirer":null,"code":null,"message":null,"authorizationId":"kh07vt","nsu":"p0dug1","tid":"i_3NEbOkCp13eGpuNm172AVYJ4"}' - name: tid value: pi_3NEbOkCp13eGpuNm172AVYJ4 - name: connector value: Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector - name: waitingForAutoSettle value: 06/06/2023 17:04:23 P UTC - name: settlementConnectorResponse value: '{"settleId":"iy20l","value":614.0,"requestId":"2023-06-02T17:05:42-61400","paymentId":"20147A81H48B64D8DA1423AFD32D6671C","code":null,"message":null}' - name: refundingConnectorResponse value: '{"refundId":null,"value":0.0,"requestId":"req_SDh1bz40RayDaI","paymentId":null,"code":"charge_already_refunded","message":"Charge ch_3NEbOkCp13eGpuNm1XGACuQG has already been refunded."}' - name: refund value: '[{"Id":"53e9229e-eac7-4fce-b353-55be479e9d6d","Token":"05136362B4464EBB99191A188033A048","RefundDate":"2023-06-02T17:05:59.4129308Z","ValueAsInt":100,"RefundType":1},{"Id":"b19bf9e5-0c13-495f-9316-41a857251be7","Token":"D8640778F8194C50BB42BD4F9D282AD8","RefundDate":"2023-06-02T17:06:08.4184954Z","ValueAsInt":61300,"RefundType":0}]' sheets: null originalPaymentId: null deprecated: false /api/pvt/transactions/{transactionId}/settlements: get: tags: - Transaction Process summary: VTex Get transaction settlement details description: "Returns settlement data associated with a specific transaction.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: TransactionSettlementDetails parameters: - $ref: '#/components/parameters/transactionId' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionSettlementDetails' example: requests: - id: AFB933448FFD4867BF82BCC7026A082C date: '2018-06-05T13:08:22' value: 4499000 actions: - paymentId: 87055E7199A446519EB07F1243D5B8BE payment: href: /api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE date: '2018-06-05T12:55:58.6262759Z' type: auto-settlement value: 4499000 connectorResponse: null deprecated: false components: schemas: Payment1: required: - href type: object description: Object containing the transaction settlement reference route. properties: href: type: string description: Transaction reference settlement route. PaymentDetailsResponse: required: - id - paymentSystem - paymentSystemName - merchantName - group - userProfileId - isCustom - allowInstallments - requiresAuthentication - allowIssuer - allowNotification - isAvailable - description - authorizationDate - self - tid - returnCode - returnMessage - status - connector - ConnectorResponses - connectorResponse - ShowConnectorResponses - value - installmentsInterestRate - installmentsValue - referenceValue - installments - currencyCode - provider - isBillingAddressDifferent - isRegexValid - isLuhnValid - fields - sheets - originalPaymentId type: object description: Payment details information. items: type: object description: Payment details information. properties: id: type: string description: Payment identification. paymentSystem: type: number description: Payment system identification. paymentSystemName: type: string description: Payment system name. merchantName: type: string description: Merchant name. nullable: true group: type: string description: Payment group name. userProfileId: type: string description: Unique ID associated with the customer profile. nullable: true isCustom: type: boolean description: Indicates whether it is custom. allowInstallments: type: boolean description: Indicates whether the payment method allows installments. requiresAuthentication: type: boolean description: Indicates whether it is necessary to log in to make the payment. allowIssuer: type: boolean description: Indicates whether it is possible to identify the name of the bank responsible for issuing the card. allowNotification: type: boolean description: Indicates the possibility of payment notification (used by bank invoices and notes payable). isAvailable: type: boolean description: Indicates whether the payment method is available for use. description: type: string description: Description of the payment method. nullable: true authorizationDate: type: string description: Payment authorization date. nullable: true self: $ref: '#/components/schemas/Self' tid: type: string description: Provider's unique identifier for the transaction. nullable: true nsu: type: string description: Provider's unique sequential number for the transaction. nullable: true returnCode: type: string description: Connector return code. nullable: true returnMessage: type: string description: Connector return message. nullable: true status: type: string description: Payment status. connector: type: string description: Connector name. nullable: true ConnectorResponses: type: array description: Array containing connector responses information. nullable: true items: type: object description: Connector responses information. properties: Tid: type: string description: Provider's unique identifier for the transaction. ReturnCode: type: string description: Connector return code. nullable: true Message: type: string description: Connector return message. nullable: true authId: type: string description: Authorization identification. nullable: true nsu: type: string description: Provider's unique sequential number for the transaction. connectorResponse: type: array description: Array containing connector response information. nullable: true items: type: object description: Connector response information. properties: Tid: type: string description: Provider's unique identifier for the transaction. ReturnCode: type: string description: Connector return code. nullable: true Message: type: string description: Connector return message. nullable: true authId: type: string description: Authorization identification. nullable: true nsu: type: string description: Provider's unique sequential number for the transaction. ShowConnectorResponses: type: boolean description: Indicates whether to display connector responses. value: type: number description: Payment value. installmentsInterestRate: type: number description: The interest rate. installmentsValue: type: number description: The value of each installment. referenceValue: type: number description: Value amount of the payment without interest applied. This value is the same as the {value` field when `installmentsInterestRate` is 0.0. installments: type: number description: Number of installments. currencyCode: type: string description: Currency Code in ISO 4217 standard. nullable: true provider: type: string description: Provider name. nullable: true isBillingAddressDifferent: type: boolean description: Indicates whether the invoice address is different from the purchase delivery address. nullable: true isRegexValid: type: boolean description: Confirms that the [Regex](https://regexr.com/) rule is valid. nullable: true isLuhnValid: type: boolean description: Confirms that the [Luhn](https://en.wikipedia.org/wiki/Luhn_algorithm) rule is valid. nullable: true fields: type: array items: $ref: '#/components/schemas/Fields1' description: Field containing information and values ​​of payment parameters. sheets: type: string description: Sheets information. nullable: true originalPaymentId: type: string description: Original payment identification, if applicable. nullable: true 2.SendPaymentsWithSavedCreditCardRequest: required: - paymentSystem - installments - currencyCode - value - installmentsInterestRate - installmentsValue - referenceValue - fields - transaction type: object description: Send payments with saved credit card request body information. properties: paymentSystem: type: number description: Payment system identification. example: 4 installments: type: number description: Number of installments. example: 1 currencyCode: type: string description: Currency code in ISO 4217 standard. example: BRL value: type: number description: Payment value. example: 30000 installmentsInterestRate: type: number description: The interest rate. example: 0 installmentsValue: type: number description: The value of each installment. example: 0 referenceValue: type: number description: Value amount of the payment without interest applied. This value is the same as the `value` field when `installmentsInterestRate` is `0.0`. example: 30000 fields: $ref: '#/components/schemas/Fields3' transaction: $ref: '#/components/schemas/Transaction' 4.DoauthorizationRequest: required: - transactionId - softDescriptor - prepareForRecurrency type: object description: Authorize new transaction request body information. properties: transactionId: type: string description: Transaction identification. example: 7ECE7DF3EEE14647B05DB904164923E8 softDescriptor: type: string description: Custom field for a transaction that can be displayed on the customer's invoice. example: company_name_description_code nullable: true prepareForRecurrency: type: boolean description: Indicates whether the transaction supports recurrence. example: false Transaction: required: - id - merchantName type: object description: Transaction information. properties: id: type: string description: Transaction identification. example: 72E84719BDF14B2FB170B38AD12598C9 merchantName: type: string description: Merchant name. example: cosmetics2 Refunds: required: - href type: object description: Object containing the reference route of transaction refunds. properties: href: type: string description: Transaction refund reference route. Self: required: - href type: object description: Object containing the payment system reference route. properties: href: type: string description: Payment system reference route. TransactionDetailsResponse: required: - id - transactionId - referenceKey - interactions - settlements - payments - refunds - cancellations - capabilities - timeoutStatus - totalRefunds - status - value - receiverUri - startDate - authorizationToken - authorizationDate - commitmentToken - commitmentDate - refundingToken - refundingDate - cancelationToken - cancelationDate - fields - shopperInteraction - ipAddress - sessionId - macId - vtexFingerprint - chargeback - whiteSignature - owner - orderId - userAgent - acceptHeader - antifraudTid - antifraudResponse - antifraudReference - antifraudAffiliationId - channel - salesChannel - urn - softDescriptor - markedForRecurrence - buyer type: object description: Transaction details response body information. properties: id: type: string description: Transaction identification. transactionId: type: string description: Transaction identification (same value of the `id` field). referenceKey: type: string description: Field used for anti-fraud to identify the transaction. interactions: $ref: '#/components/schemas/Interactions' settlements: $ref: '#/components/schemas/Settlements' payments: $ref: '#/components/schemas/Payments' refunds: $ref: '#/components/schemas/Refunds' cancellations: $ref: '#/components/schemas/Cancellations' capabilities: $ref: '#/components/schemas/Capabilities' timeoutStatus: type: number description: 'Field that represents the possible transaction timeout statuses. Possible statuses and meanings: `0` = NotStarted, `1` = CancellingOrFinishing, `2` = CancellingOrFinishingByTimeout, `3` = CancelledOrFinished and `4` = TriesExceeded.' enum: - 0 - 1 - 2 - 3 - 4 totalRefunds: type: number description: Total refunded transaction amount. status: type: string description: Transaction status. value: type: number description: Transaction value. receiverUri: type: string description: Receiver [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) information. nullable: true startDate: type: string description: Transaction start date. authorizationToken: type: string description: Transaction authorization token. nullable: true authorizationDate: type: string description: Transaction authorization date. nullable: true commitmentToken: type: string description: Transaction completion token. nullable: true commitmentDate: type: string description: Transaction completion date. nullable: true refundingToken: type: string description: Transaction refund token. nullable: true refundingDate: type: string description: Transaction refund date. nullable: true cancelationToken: type: string description: Transaction cancellation token. nullable: true cancelationDate: type: string description: Transaction cancellation date. nullable: true fields: type: array items: $ref: '#/components/schemas/Fields1' description: Field containing information and values of payment parameters. shopperInteraction: type: string description: Transaction origin. ipAddress: type: string description: Ip address information. nullable: true sessionId: type: string description: Session identification. nullable: true macId: type: string description: Random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) V4 generated when the Request Capture receives a session that does not contain the macID already set. This value is set to the cookie `VtexRCMacIdv7`. The cookie has 1 year of expiration. vtexFingerprint: type: string description: VTEX fingerprint information. nullable: true chargeback: type: string description: Chargeback information. nullable: true whiteSignature: type: string description: White signature (anti-fraud list) information. nullable: true owner: type: string description: Responsible for transaction request. orderId: type: string description: Order identitication. nullable: true userAgent: type: string description: HTTP client used in the transaction. acceptHeader: type: string description: Type of content accepted in the transaction request header. antifraudTid: type: string description: Anti-fraud transaction identification. nullable: true antifraudResponse: type: string description: Anti-fraud response information. nullable: true antifraudReference: type: string description: Anti-fraud reference information. nullable: true antifraudAffiliationId: type: string description: Anti-fraud affiliation identification. nullable: true channel: type: string description: Store where the transaction was initiated. salesChannel: type: string description: Sales channel information. urn: type: string description: '[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.' nullable: true softDescriptor: type: string description: Custom field for a transaction that can be displayed on the customer's invoice. nullable: true markedForRecurrence: type: boolean description: Indicates whether the payment transaction should be recurring. buyer: type: object description: Buyer information. nullable: true properties: firstName: type: string description: Buyer first name. lastName: type: string description: Buyer last name. documentType: type: string description: Type of the document informed by the buyer. document: type: string description: Document informed by the buyer. email: type: string description: Buyer email address. address: type: string description: Buyer address. phone: type: string description: Buyer phone number. Cancellations: required: - href type: object description: Object containing the reference route of transaction cancellations. properties: href: type: string description: Transaction cancellation reference route. Fields1: required: - name - value type: object description: Payment parameters information. properties: name: type: string description: Payment parameter name. value: type: string description: Payment parameter value. Fields: required: - holderName - cardNumber - validationCode - dueDate - document - accountId - address - callbackUrl type: object description: Fields information. properties: holderName: type: string description: Card holder name. example: UserTest nullable: true cardNumber: type: number description: Card number information. example: 111111111111 nullable: true validationCode: type: number description: CVV code. example: 231 nullable: true dueDate: type: string description: Due date information. The date format is `mm/yy`. example: 10/19 nullable: true document: type: string description: Card holder documentation. example: '8041734561' nullable: true accountId: type: string description: Account identification. example: 08134AF761A148B9A5DCE14A81F31DD9 nullable: true address: type: array description: Array containing customer address information. items: type: object description: Customer address information. properties: addressType: type: string description: Address type. example: Residential receiverName: type: string description: Name of the receiver. example: Clark Kent postalCode: type: string description: Postal code information. example: '5555555' city: type: string description: City of the address. example: Sao Paulo state: type: string description: State of the address. example: SP country: type: string description: Country of the address. ISO three-letter code. nullable: true example: BRA street: type: string description: Street of the address. example: Avenue Splendor Garden number: type: number description: Number of the address. example: 111 neighborhood: type: string description: Neighborhood of the address. example: Sumare complement: type: string description: Complement to the address. example: House nullable: true reference: type: string description: Reference that may help in the location of the address. example: Close to the bank. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. example: - -47.924747467041016 - -15.832582473754883 items: type: number description: Geocoordinates information. example: -47.924747467041016 callbackUrl: type: string description: Callback URL information. example: https://coinshop.vtexpayments.com.br/payment-provider/transactions/900BA26FEAC84332A53AE1007E740DE3/payments/E713830E32764BF99028A0A275841BFC/notification Action: required: - paymentId - payment - date - type - value - connectorResponse type: object description: Actions information. properties: paymentId: type: string description: Payment identification. payment: $ref: '#/components/schemas/Payment1' date: type: string description: Transaction settlement date. type: type: string description: Settlement action date. value: type: integer description: Transaction settlement value. connectorResponse: type: string description: Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `authId`, among others). nullable: true Request: required: - id - date - value type: object description: Requests information. properties: id: type: string description: Transaction identification. This is the same `transactionId` value sent in the request path. date: type: string description: Transaction settlement date. value: type: number description: Transaction settlement value. SettleResponse: required: - id - token - status - statusDetail - processingDate - refundedValue - refundedToken - message - code - connectorRefundedValue - cancelledValue type: object description: ' Transaction response body information.' properties: id: type: string description: Settle request identification. nullable: true token: type: string description: Token identification. status: type: number description: Status code. statusDetail: type: string description: Status detail information. processingDate: type: string description: Settlement processing date. refundedValue: type: integer description: Refunded value. refundedToken: type: string description: Refund operation token. nullable: true message: type: string description: Custom message. nullable: true code: type: string description: Custom code. nullable: true connectorRefundedValue: type: number description: Refunded value by connector (provider). cancelledValue: type: integer description: Cancelled value. Payments: required: - href type: object description: Object containing the reference route of transaction payments. properties: href: type: string description: Transaction payment reference route. 2.SendPaymentsPublicRequest: required: - paymentSystem - installments - currencyCode - value - installmentsInterestRate - installmentsValue - referenceValue - fields - transaction type: object description: Send payments information public request body information. properties: paymentSystem: type: number description: Payment system identification. example: 17 installments: type: number description: Number of installments. example: 1 currencyCode: type: string description: Currency code in ISO 4217 standard. example: BRL value: type: number description: Payment value. example: 15000 installmentsInterestRate: type: number description: The interest rate. example: 0 installmentsValue: type: number description: The value of each installment. example: 0 referenceValue: type: number description: Value amount of the payment without interest applied. This value is the same as the `value` field when `installmentsInterestRate` is `0.0`. example: 15000 fields: $ref: '#/components/schemas/Fields' transaction: $ref: '#/components/schemas/Transaction' TransactionSettlementDetails: required: - requests - actions type: object description: Transaction settlement details response body information. properties: requests: type: array items: $ref: '#/components/schemas/Request' description: Array containing requests information. actions: type: array items: $ref: '#/components/schemas/Action' description: Array containing actions information. Interactions: required: - href type: object description: Object containing the reference route of transaction interactions. properties: href: type: string description: Transaction interaction reference route. Settlements: required: - href type: object description: Object containing the reference route of transaction settlements. properties: href: type: string description: Transaction settlement reference route. Capabilities: required: - href type: object description: Object containing the reference route of transaction capabilities. properties: href: type: string description: Transaction capabilities reference route. Field: required: - name - value type: object description: Transaction parameters information. properties: name: type: string description: Transaction parameter name. value: type: string description: Transaction parameter value. 1.CreateanewtransactionRequest: required: - value - referenceId - channel - salesChannel type: object description: New transaction request body information. properties: value: type: number description: Transaction value. The value must be described without using separation for decimals, e.g. for a transaction with a value equal to 201.50, send 20150. example: 20000 referenceId: type: string description: Identification number that relates the transaction to a purchase order. example: '1234567' channel: type: string description: Store where the transaction was initiated. example: cosmetics2 urn: type: string description: '[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.' example: urn:amazon:webservices:clientvpn nullable: true salesChannel: type: string description: Sales channel information. example: '1' Fields3: required: - holderName - cardNumber - validationCode - dueDate - document - accountId - address - callbackUrl type: object description: Fields information. properties: holderName: type: string description: Card holder name. example: UserTest cardNumber: type: number description: Card number information. example: 111111111111 validationCode: type: number description: CVV code. example: 231 dueDate: type: string description: Due date information. The date format is `mm/yy`. example: 10/19 document: type: string description: Card holder documentation. example: '8041734561' accountId: type: string description: Account identification. example: 08134AF761A148B9A5DCE14A81F31DD9 nullable: true address: type: array description: Array containing customer address information. items: type: string description: Customer address information. example: Customer address data nullable: true callbackUrl: type: string description: Callback URL information. example: https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success nullable: true StartTransactionResponse: required: - id - transactionId - referenceKey - interactions - settlements - payments - refunds - cancellations - capabilities - timeoutStatus - totalRefunds - status - value - receiverUri - startDate - authorizationToken - authorizationDate - commitmentToken - commitmentDate - refundingToken - refundingDate - cancelationToken - cancelationDate - fields - ipAddress - sessionId - macId - vtexFingerprint - chargeback - whiteSignature - owner - orderId - userAgent - acceptHeader - antifraudTid - antifraudResponse - antifraudReference - antifraudAffiliationId - channel - salesChannel - urn - softDescriptor - markedForRecurrence - buyer type: object description: New transaction response body information. properties: id: type: string description: Transaction identification. transactionId: type: string description: Transaction identification (same value of the `id` field). referenceKey: type: string description: Identification number that relates the transaction to a purchase order. It can be also used for anti-fraud to identify the transaction. interactions: $ref: '#/components/schemas/Interactions' settlements: $ref: '#/components/schemas/Settlements' payments: $ref: '#/components/schemas/Payments' refunds: $ref: '#/components/schemas/Refunds' cancellations: $ref: '#/components/schemas/Cancellations' capabilities: $ref: '#/components/schemas/Capabilities' timeoutStatus: type: number description: 'Field that represents the possible transaction timeout statuses. Possible statuses and meanings: `0` = NotStarted, `1` = CancellingOrFinishing, `2` = CancellingOrFinishingByTimeout, `3` = CancelledOrFinished and `4` = TriesExceeded.' enum: - 0 - 1 - 2 - 3 - 4 totalRefunds: type: number description: Total refunded transaction amount. status: type: string description: Transaction status. value: type: number description: Transaction value. receiverUri: type: string description: Receiver [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) information. nullable: true startDate: type: string description: Transaction start date. authorizationToken: type: string description: Transaction authorization token. nullable: true authorizationDate: type: string description: Transaction authorization date. nullable: true commitmentToken: type: string description: Transaction completion token. nullable: true commitmentDate: type: string description: Transaction completion date. nullable: true refundingToken: type: string description: Transaction refund token. nullable: true refundingDate: type: string description: Transaction refund date. nullable: true cancelationToken: type: string description: Transaction cancellation token. nullable: true cancelationDate: type: string description: Transaction cancellation date. nullable: true fields: type: array items: $ref: '#/components/schemas/Field' description: Field containing transaction information. ipAddress: type: string description: IP address information. nullable: true sessionId: type: string description: Session identification. nullable: true macId: type: string description: Random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) V4 generated when the Request Capture receives a session that does not contain the macID already set. This value is set to the cookie `VtexRCMacIdv7`. The cookie has 1 year of expiration. nullable: true vtexFingerprint: type: string description: VTEX fingerprint information. nullable: true chargeback: type: string description: Chargeback information. nullable: true whiteSignature: type: string description: White signature (anti-fraud list) information. nullable: true owner: type: string description: Responsible for transaction request. orderId: type: string description: Order identitication. nullable: true userAgent: type: string description: HTTP client used in the transaction. nullable: true acceptHeader: type: string description: Type of content accepted in the transaction request header. nullable: true antifraudTid: type: string description: Anti-fraud transaction identification. nullable: true antifraudResponse: type: string description: Anti-fraud response information. nullable: true antifraudReference: type: string description: Anti-fraud reference information. nullable: true antifraudAffiliationId: type: string description: Anti-fraud affiliation identification. nullable: true channel: type: string description: Store where the transaction was initiated. salesChannel: type: string description: Sales channel information. urn: type: string description: '[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.' nullable: true softDescriptor: type: string description: Custom field for a transaction that can be displayed on the customer's invoice. nullable: true markedForRecurrence: type: boolean description: Indicates whether the payment transaction should be recurring. buyer: type: object description: Buyer information. nullable: true properties: firstName: type: string description: Buyer first name. lastName: type: string description: Buyer last name. documentType: type: string description: Type of the document informed by the buyer. document: type: string description: Document informed by the buyer. email: type: string description: Buyer email address. address: type: string description: Buyer address. phone: type: string description: Buyer phone number. parameters: Accept: name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string example: application/json transactionId: name: transactionId in: path description: Transaction identification. required: true style: simple schema: type: string example: A3BDE325F76B4B758B398D900DF06150 securitySchemes: VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'