@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Payments Gateway API
@base https://apiexamples.vtexpayments.com.br
@version 1.0
@auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header
@common_fields {Content-Type: str # Type of the content being sent., Accept: str # HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.}
@endpoints 25
@hint download_for_search
@toc api(25)

@endpoint GET /api/pvt/installments
@desc Get installments options
@required {request.value: int # Value to be divided into installments.}
@optional {request.salesChannel: int # Sales channel identification. Attribute created by the seller in their VTEX store configuration., request.paymentDetails[0].id: int # Payment system identification., request.paymentDetails[0].value: int # Total value paid in installments. If applied in the search, it must be equal to the `request.value` field., request.paymentDetails[0].bin: int # First six digits of the card number.}
@returns(200) {value: num, installments: [map]} # OK
@errors {400: Bad Request}

@endpoint GET /api/pvt/affiliations
@desc List all affiliations
@returns(200) OK

@endpoint POST /api/pvt/affiliations
@desc Insert new affiliation
@required {implementation: str # Provider implementation class name., name: str # Provider name., configuration: [map{name!: str, value!: str}] # Array containing provider configuration information., isdelivered: bool # Indicates whether the provider is published and available for use., isConfigured: bool # Indicates whether the provider is configured.}
@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK
@example_request {"implementation":"Vtex.PaymentGateway.Connectors.CieloV3Connector","name":"CieloV3 - Test","configuration":[{"name":"HowTo","value":"https://developercielo.github.io/payment-method-enablement/"},{"name":"MerchantId","value":"sampleData"},{"name":"MerchantKey","value":"**********"}],"isdelivered":true,"isConfigured":true}

@endpoint PUT /api/pvt/affiliations/{affiliationId}
@desc Update affiliation by ID
@required {affiliationId: str # Affiliation (payment or anti-fraud provider) identification., id: str # Provider identification., implementation: str # Provider implementation class name., name: str # Provider name., configuration: [map{name!: str, value!: str, valueKey!: str}] # Array containing provider configuration information., isdelivered: bool # Indicates whether the provider is published and available for use., isConfigured: bool # Indicates whether the provider is configured.}
@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK
@example_request {"id":"fg8b4ea5-0b24-47dc-971e-2f6635ea1f14","implementation":"Vtex.PaymentGateway.Connectors.CieloV3Connector","name":"CieloV3 - Test","configuration":[{"name":"HowTo","value":"https://developercielo.github.io/payment-method-enablement/","valueKey":null},{"name":"MerchantId","value":"sampleData","valueKey":null},{"name":"MerchantKey","value":"**********","valueKey":null}],"isdelivered":true,"isConfigured":true}

@endpoint GET /api/pvt/affiliations/{affiliationId}
@desc Get affiliation by ID
@required {affiliationId: str # Affiliation (payment or anti-fraud provider) identification.}
@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK

@endpoint GET /api/pvt/rules
@desc List all payment rules
@returns(200) OK

@endpoint POST /api/pvt/rules
@desc Insert a new payment rule
@required {name: str # Rule name., salesChannels: [map{id!: str}] # Array containing information about the Sales channel., paymentSystem: map{id!: num, name!: str, implementation!: str} # Payment system information., connector: map{implementation!: str, affiliationId!: str} # Connector (payment provider) information., issuer: map{name!: str} # Card issuer information., antifraud: map{implementation!: str, affiliationId!: str} # Anti-fraud information., installmentOptions: map{dueDateType!: num, interestRateMethod!: num, minimumInstallmentValue!: num, installments!: [map]} # Installment options information., isSelfAuthorized: bool # Indicates whether the payment is automatically authorized., requiresAuthentication: bool # Indicates whether it is necessary to log in to make the payment., enabled: bool # Indicates whether the rule is enabled in the store., installmentsService: bool # Indicates whether any specific type of installment service is used., isDefault: bool # Indicates whether this rule should be considered the default for a given payment condition., beginDate: str # Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable., endDate: str # Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable., condition: map{id!: str, pullRate!: num, name!: str} # Commercial condition information., multiMerchantList: [str] # Indicates the names of the accounts to which the rule is being applied exclusively., country: map{name!: str, isoCode!: str} # Information about rule application in a country., dateIntervals: [map{start!: str, end!: str}] # Array containing information about the periods (days and hours) in which the rule is enabled.}
@optional {externalInterest: bool # Indicates whether interest can be calculated externally., minimumValue: num # Minimum payment transaction amount for the rule to be applied., deadlines: [map{paymentOptions!: [map]}] # Array containing information about the payment deadlines (applicable for credit payment method)., cobrand: map{name!: str} # Information about the cobranded card., cardLevel: map{name!: str} # Information about the card category., excludedBinsRanges: num # Range of card bins excluded from application of this rule.}
@returns(200) {id: str, name: str, salesChannels: [map], paymentSystem: map{id: num, name: str, implementation: str?}, connector: map?{implementation: str, affiliationId: str}, issuer: map{name: str?}, antifraud: map?{implementation: str?, affiliationId: str?}, installmentOptions: map?{dueDateType: num, interestRateMethod: num?, minimumInstallmentValue: num, installments: [map]}, isSelfAuthorized: bool?, requiresAuthentication: bool?, enabled: bool, installmentsService: bool, isDefault: bool?, beginDate: str?, endDate: str?, condition: map?{id: str, pullRate: num, name: str?}, multiMerchantList: [str]?, country: map?{name: str?, isoCode: str}, dateIntervals: [map]?, externalInterest: bool, minimumValue: num?, deadlines: [map], cobrand: map{name: str?}, cardLevel: map{name: str?}, excludedBinsRanges: num?} # OK
@example_request {"name":"Test_API_2","salesChannels":[{"id":"1"}],"paymentSystem":{"id":8,"name":"Hipercard","implementation":null},"connector":{"implementation":"Vtex.PaymentGateway.Connectors.CieloV3Connector","affiliationId":"0a8488e6-0c30-4150-be96-b0dcaaa6a0cd"},"issuer":{"name":"barclays"},"antifraud":{"implementation":null,"affiliationId":null},"installmentOptions":{"dueDateType":1,"interestRateMethod":2,"minimumInstallmentValue":50,"installments":[{"ruleId":null,"quantity":6,"value":0,"interestRate":15,"isExternalInstallmentService":null,"interestTax":0}]},"isSelfAuthorized":null,"requiresAuthentication":null,"enabled":false,"installmentsService":false,"isDefault":null,"beginDate":"2023-12-10T17:00:00Z","endDate":"2023-12-22T01:00:00Z","condition":{"id":"1","pullRate":0,"name":null},"multiMerchantList":["cosmetics2"],"country":{"name":null,"isoCode":"us"},"dateIntervals":[{"start":"* * 11 * * 1,3,4 * -0300","end":"* * 18 * * 1,3,4 * -0300"},{"start":"* * 05 * * * * -0300","end":"* * 23 * * * * -0300"}],"externalInterest":false,"minimumValue":null,"deadlines":[],"cobrand":{"name":null},"cardLevel":{"name":"business"},"excludedBinsRanges":null}

@endpoint GET /api/pvt/rules/{ruleId}
@desc Get payment rule by ID
@required {ruleId: str # Rule identification.}
@returns(200) {id: str, name: str, salesChannels: [map], paymentSystem: map{id: num, name: str, implementation: str?}, connector: map?{implementation: str, affiliationId: str}, issuer: map{name: str?}, antifraud: map?{implementation: str?, affiliationId: str?}, installmentOptions: map?{dueDateType: num, interestRateMethod: num?, minimumInstallmentValue: num, installments: [map]}, isSelfAuthorized: bool?, requiresAuthentication: bool?, enabled: bool, installmentsService: bool, isDefault: bool?, beginDate: str?, endDate: str?, condition: map?{id: str, pullRate: num, name: str?}, multiMerchantList: [str]?, country: map?{name: str?, isoCode: str}, dateIntervals: [map]?, externalInterest: bool, minimumValue: num?, deadlines: [map], cobrand: map{name: str?}, cardLevel: map{name: str?}, excludedBinsRanges: num?} # OK

@endpoint PUT /api/pvt/rules/{ruleId}
@desc Update payment rule by ID
@required {ruleId: str # Rule identification., id: str # Rule identification., name: str # Rule name., salesChannels: [map{id!: str}] # Array containing information about the Sales channel., paymentSystem: map{id!: num, name!: str, implementation!: str} # Payment system information., connector: map{implementation!: str, affiliationId!: str} # Connector (payment provider) information., issuer: map{name!: str} # Card issuer information., antifraud: map{implementation!: str, affiliationId!: str} # Anti-fraud information., installmentOptions: map{dueDateType!: num, interestRateMethod!: num, minimumInstallmentValue!: num, installments!: [map]} # Installment options information., isSelfAuthorized: bool # Indicates whether the payment is automatically authorized., requiresAuthentication: bool # Indicates whether it is necessary to log in to make the payment., enabled: bool # Indicates whether the rule is enabled in the store., installmentsService: bool # Indicates whether any specific type of installment service is used., isDefault: bool # Indicates whether this rule should be considered the default for a given payment condition., beginDate: str # Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable., endDate: str # Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable., condition: map{id!: str, pullRate!: num, name!: str} # Commercial condition information., multiMerchantList: [str] # Indicates the names of the accounts to which the rule is being applied exclusively., country: map{name!: str, isoCode!: str} # Information about rule application in a country., dateIntervals: [map{start!: str, end!: str}] # Array containing information about the periods (days and hours) in which the rule is enabled.}
@optional {externalInterest: bool # Indicates whether interest can be calculated externally., minimumValue: num # Minimum payment transaction amount for the rule to be applied., deadlines: [map{paymentOptions!: [map]}] # Array containing information about the payment deadlines (applicable for credit payment method)., cobrand: map{name!: str} # Information about the cobranded card., cardLevel: map{name!: str} # Information about the card category., excludedBinsRanges: num # Range of card bins excluded from application of this rule.}
@returns(200) {id: str, name: str, salesChannels: [map], paymentSystem: map{id: num, name: str, implementation: str?}, connector: map?{implementation: str, affiliationId: str}, issuer: map{name: str?}, antifraud: map?{implementation: str?, affiliationId: str?}, installmentOptions: map?{dueDateType: num, interestRateMethod: num?, minimumInstallmentValue: num, installments: [map]}, isSelfAuthorized: bool?, requiresAuthentication: bool?, enabled: bool, installmentsService: bool, isDefault: bool?, beginDate: str?, endDate: str?, condition: map?{id: str, pullRate: num, name: str?}, multiMerchantList: [str]?, country: map?{name: str?, isoCode: str}, dateIntervals: [map]?, externalInterest: bool, minimumValue: num?, deadlines: [map], cobrand: map{name: str?}, cardLevel: map{name: str?}, excludedBinsRanges: num?} # OK
@example_request {"id":"c997267e-39bf-4217-a890-a503f6a7dc47","name":"Test_API_2_Updated","salesChannels":[{"id":"1"}],"paymentSystem":{"id":8,"name":"Hipercard","implementation":null},"connector":{"implementation":"Vtex.PaymentGateway.Connectors.CieloV3Connector","affiliationId":"0a8488e6-0c30-4150-be96-b0dcaaa6a0cd"},"issuer":{"name":"barclays"},"antifraud":null,"installmentOptions":{"dueDateType":0,"interestRateMethod":1,"minimumInstallmentValue":400,"installments":[{"ruleId":null,"quantity":12,"value":0,"interestRate":25,"isExternalInstallmentService":null,"interestTax":0}]},"isSelfAuthorized":null,"requiresAuthentication":null,"enabled":false,"installmentsService":false,"isDefault":null,"beginDate":"2023-12-15T17:00:00Z","endDate":"2023-12-30T01:00:00Z","condition":{"id":"1","pullRate":15,"name":null},"multiMerchantList":[],"country":{"name":null,"isoCode":"br"},"dateIntervals":[{"start":"* * 12 * * 1,3,4 * -0300","end":"* * 19 * * 1,3,4 * -0300"},{"start":"* * 09 * * * * -0300","end":"* * 21 * * * * -0300"}],"externalInterest":false,"minimumValue":null,"deadlines":[],"cobrand":{"name":null},"cardLevel":{"name":"gold"},"excludedBinsRanges":null}

@endpoint DELETE /api/pvt/rules/{ruleId}
@desc Delete payment rule by ID
@required {ruleId: str # Rule identification.}
@returns(200) OK
 
 This endpoint does not return a response body.

@endpoint GET /api/pvt/merchants/payment-systems
@desc List all available payment methods
@optional {salesChannel: int # Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) identification. This parameter must be filled in if you wish to obtain information on payment methods available in a specific store sales channel.}
@returns(200) OK

@endpoint GET /api/payments/pvt/account/{cardId}
@desc Get card data
@required {cardId: str # Card identification. This is the `accountId` associated with the client's profile, which can be viewed by accessing [Profile System](https://developers.vtex.com/docs/guides/profile-system#profile-system-api-reference). As a client can have more than one card registered in their profile, check the desired `accountId` and send it in this request.}
@returns(200) {bin: str, lastDigits: str, expiryMonth: str, expiryYear: str, mask: str, paymentSystem: int, paymentSystemName: str, address: map{addressType: str, addressId: str, postalCode: str, street: str, neighborhood: str, city: str, state: str, country: str, number: str, complement: str}, document: str, tokens: map{providerId: str, type: str, value: str, expiration: str, label: str, href: str, providerCardTokenId: str, useCvvForAuthorization: bool, extraData: map{customField1: str}}} # OK
@errors {404: Not Found, 500: Internal Server Error
 
 Payment system not found for the card.}

@endpoint POST /api/pvt/transactions
@desc Start a new transaction
@required {value: num # 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., referenceId: str # Identification number that relates the transaction to a purchase order., channel: str # Store where the transaction was initiated., salesChannel: str # Sales channel information.}
@optional {urn: str # [URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.}
@returns(200) {id: str, transactionId: str, referenceKey: str, interactions: map{href: str}, settlements: map{href: str}, payments: map{href: str}, refunds: map{href: str}, cancellations: map{href: str}, capabilities: map{href: str}, timeoutStatus: num, totalRefunds: num, status: str, value: num, receiverUri: str?, startDate: str, authorizationToken: str?, authorizationDate: str?, commitmentToken: str?, commitmentDate: str?, refundingToken: str?, refundingDate: str?, cancelationToken: str?, cancelationDate: str?, fields: [map], ipAddress: str?, sessionId: str?, macId: str?, vtexFingerprint: str?, chargeback: str?, whiteSignature: str?, owner: str, orderId: str?, userAgent: str?, acceptHeader: str?, antifraudTid: str?, antifraudResponse: str?, antifraudReference: str?, antifraudAffiliationId: str?, channel: str, salesChannel: str, urn: str?, softDescriptor: str?, markedForRecurrence: bool, buyer: map?{firstName: str, lastName: str, documentType: str, document: str, email: str, address: str, phone: str}} # OK
@example_request {"value":20000,"referenceId":"1234567","channel":"cosmetics2","urn":"urn:amazon:webservices:clientvpn","salesChannel":"1"}

@endpoint POST /api/payments/transactions/{transactionId}/payments
@desc Send payments information
@required {an: str # Account name., orderId: str # Order identification., transactionId: str # Transaction identification.}
@returns(201) Created
 
 This endpoint does not return a response body.
@example_request [{"paymentSystem":17,"installments":1,"currencyCode":"BRL","value":15000,"installmentsInterestRate":0,"installmentsValue":15000,"referenceValue":15000,"fields":{"holderName":"UserTest","cardNumber":"111111111111","validationCode":"231","dueDate":"10/19","document":"8041734561","accountId":"08134AF761A148B9A5DCE14A81F31DD9","address":{"addressType":"Residential","receiverName":"Clark Kent","postalCode":"5555555","city":"Sao Paulo","state":"SP","country":"BRA","street":"Avenue Splendor Garden","number":111,"neighborhood":"Sumare","complement":"House","reference":"Close to the bank."},"callbackUrl":"https://coinshop.vtexpayments.com.br/payment-provider/transactions/900BA26FEAC84332A53AE1007E740DE3/payments/E713830E32764BF99028A0A275841BFC/notification"},"transaction":{"id":"72E84719BDF14B2FB170B38AD12598C9","merchantName":"cosmetics2"}}]

@endpoint POST /api/pvt/transactions/{transactionId}/additional-data
@desc Send additional data
@required {transactionId: str # Transaction identification.}
@returns(200) OK
 
 This endpoint does not return a response body.
@example_request [{"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\"}"}]

@endpoint PATCH /api/pvt/transactions/{transactionId}/additional-data
@desc Update additional data
@required {transactionId: str # Transaction identification.}
@returns(200) OK
 
 This endpoint does not return a response body.
@example_request [{"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\"}"}]

@endpoint POST /api/pvt/transactions/{transactionId}/authorization-request
@desc Authorize new transaction
@required {transactionId: str # Transaction identification., transactionId: str # Transaction identification., softDescriptor: str # Custom field for a transaction that can be displayed on the customer's invoice., prepareForRecurrency: bool # Indicates whether the transaction supports recurrence.}
@returns(200) {id: str?, token: str, status: num, statusDetail: str, processingDate: str, refundedValue: int, refundedToken: str?, message: str?, code: str?, connectorRefundedValue: num, cancelledValue: int} # OK
@example_request {"transactionId":"7ECE7DF3EEE14647B05DB904164923E8","softDescriptor":"company_name_description_code","prepareForRecurrency":false}

@endpoint GET /api/pvt/transactions/{transactionId}
@desc Get transaction details
@required {transactionId: str # Transaction identification.}
@returns(200) {id: str, transactionId: str, referenceKey: str, interactions: map{href: str}, settlements: map{href: str}, payments: map{href: str}, refunds: map{href: str}, cancellations: map{href: str}, capabilities: map{href: str}, timeoutStatus: num, totalRefunds: num, status: str, value: num, receiverUri: str?, startDate: str, authorizationToken: str?, authorizationDate: str?, commitmentToken: str?, commitmentDate: str?, refundingToken: str?, refundingDate: str?, cancelationToken: str?, cancelationDate: str?, fields: [map], shopperInteraction: str, ipAddress: str?, sessionId: str?, macId: str, vtexFingerprint: str?, chargeback: str?, whiteSignature: str?, owner: str, orderId: str?, userAgent: str, acceptHeader: str, antifraudTid: str?, antifraudResponse: str?, antifraudReference: str?, antifraudAffiliationId: str?, channel: str, salesChannel: str, urn: str?, softDescriptor: str?, markedForRecurrence: bool, buyer: map?{firstName: str, lastName: str, documentType: str, document: str, email: str, address: str, phone: str}} # OK

@endpoint GET /api/pvt/transactions/{transactionId}/payments/{paymentId}
@desc Get payment details
@required {transactionId: str # Transaction identification.}
@optional {paymentId: str # Payment identification.}
@returns(200) {id: str, paymentSystem: num, paymentSystemName: str, merchantName: str?, group: str, userProfileId: str?, isCustom: bool, allowInstallments: bool, requiresAuthentication: bool, allowIssuer: bool, allowNotification: bool, isAvailable: bool, description: str?, authorizationDate: str?, self: map{href: str}, tid: str?, nsu: str?, returnCode: str?, returnMessage: str?, status: str, connector: str?, ConnectorResponses: map{Tid: str, ReturnCode: str?, Message: str?, authId: str?, nsu: str}, connectorResponse: map{Tid: str, ReturnCode: str?, Message: str?, authId: str?, nsu: str}, ShowConnectorResponses: bool, value: num, installmentsInterestRate: num, installmentsValue: num, referenceValue: num, installments: num, currencyCode: str?, provider: str?, isBillingAddressDifferent: bool?, isRegexValid: bool?, isLuhnValid: bool?, fields: [map], sheets: str?, originalPaymentId: str?} # OK

@endpoint GET /api/pvt/transactions/{transactionId}/settlements
@desc Get transaction settlement details
@required {transactionId: str # Transaction identification.}
@returns(200) {requests: [map], actions: [map]} # OK

@endpoint POST /api/pvt/transactions/{transactionId}/settlement-request
@desc Settle the transaction
@required {transactionId: str # Transaction identification., value: num # Value to be settled. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050.}
@returns(200) {id: str?, token: str, status: num, statusDetail: str, processingDate: str, refundedValue: int, refundedToken: str?, message: str?, code: str?, connectorRefundedValue: num, cancelledValue: int} # OK
@example_request {"value":10050}

@endpoint POST /api/pvt/transactions/{transactionId}/refunding-request
@desc Refund the transaction
@required {transactionId: str # Transaction identification., value: num # Purchase value. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050.}
@optional {freight: num # Freigth value, if applicable., tax: num # Tax value, if applicable., minicart: map # This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/docs/api-reference/orders-api?endpoint=get-/api/oms/pvt/orders/-orderId-) or [Transaction Details](https://developers.vtex.com/docs/api-reference/payments-gateway-api?endpoint=get-/api/pvt/transactions/-transactionId-) endpoints. It should only be included for transactions with split payment.}
@returns(200) {id: str?, token: str, status: num, statusDetail: str, processingDate: str, refundedValue: int, refundedToken: str?, message: str?, code: str?, connectorRefundedValue: num, cancelledValue: int} # OK
@example_request {"value":2300,"freight":200,"tax":0,"minicart":{"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}]}}

@endpoint POST /api/pvt/transactions/{transactionId}/cancellation-request
@desc Cancel the transaction
@required {transactionId: str # Transaction identification., value: num # Value of the purchase that will be cancelled.}
@returns(200) {id: str?, token: str, status: num, statusDetail: str, processingDate: str, refundedValue: int, refundedToken: str?, message: str?, code: str?, connectorRefundedValue: num, cancelledValue: int} # OK
@example_request {"value":2300}

@endpoint GET /api/payments/pvt/payments/{paymentId}/payment-notification
@desc Send payment notification with payment ID
@required {paymentId: str # Payment identification.}
@returns(200) OK

@endpoint POST /api/payments/pvt/payments/{paymentId}/payment-notification
@desc Send payment notification with payment ID, date, and value paid
@required {paymentId: str # Payment identification., paymentDate: str # Date when the payment was made, in DD/MM/YYYY format., valuePaid: num # Value that was paid.}
@returns(200) OK
@example_request {"paymentDate":"01/01/2025","valuePaid":50.1}

@end