{"files":{"SKILL.md":"---\nname: payments-gateway-api\ndescription: \"Payments Gateway API skill. Use when working with Payments Gateway for api. Covers 25 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Payments Gateway API\nAPI version: 1.0\n\n## Auth\nApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n\n## Base URL\nhttps://apiexamples.vtexpayments.com.br\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /api/pvt/installments -- verify access\n3. POST /api/pvt/affiliations -- create first affiliations\n\n## Endpoints\n\n25 endpoints across 1 groups. See references/api-spec.lap for full details.\n\n### api\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /api/pvt/installments | Get installments options |\n| GET | /api/pvt/affiliations | List all affiliations |\n| POST | /api/pvt/affiliations | Insert new affiliation |\n| PUT | /api/pvt/affiliations/{affiliationId} | Update affiliation by ID |\n| GET | /api/pvt/affiliations/{affiliationId} | Get affiliation by ID |\n| GET | /api/pvt/rules | List all payment rules |\n| POST | /api/pvt/rules | Insert a new payment rule |\n| GET | /api/pvt/rules/{ruleId} | Get payment rule by ID |\n| PUT | /api/pvt/rules/{ruleId} | Update payment rule by ID |\n| DELETE | /api/pvt/rules/{ruleId} | Delete payment rule by ID |\n| GET | /api/pvt/merchants/payment-systems | List all available payment methods |\n| GET | /api/payments/pvt/account/{cardId} | Get card data |\n| POST | /api/pvt/transactions | Start a new transaction |\n| POST | /api/payments/transactions/{transactionId}/payments | Send payments information |\n| POST | /api/pvt/transactions/{transactionId}/additional-data | Send additional data |\n| PATCH | /api/pvt/transactions/{transactionId}/additional-data | Update additional data |\n| POST | /api/pvt/transactions/{transactionId}/authorization-request | Authorize new transaction |\n| GET | /api/pvt/transactions/{transactionId} | Get transaction details |\n| GET | /api/pvt/transactions/{transactionId}/payments/{paymentId} | Get payment details |\n| GET | /api/pvt/transactions/{transactionId}/settlements | Get transaction settlement details |\n| POST | /api/pvt/transactions/{transactionId}/settlement-request | Settle the transaction |\n| POST | /api/pvt/transactions/{transactionId}/refunding-request | Refund the transaction |\n| POST | /api/pvt/transactions/{transactionId}/cancellation-request | Cancel the transaction |\n| GET | /api/payments/pvt/payments/{paymentId}/payment-notification | Send payment notification with payment ID |\n| POST | /api/payments/pvt/payments/{paymentId}/payment-notification | Send payment notification with payment ID, date, and value paid |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all installments?\" -> GET /api/pvt/installments\n- \"List all affiliations?\" -> GET /api/pvt/affiliations\n- \"Create a affiliation?\" -> POST /api/pvt/affiliations\n- \"Update a affiliation?\" -> PUT /api/pvt/affiliations/{affiliationId}\n- \"Get affiliation details?\" -> GET /api/pvt/affiliations/{affiliationId}\n- \"List all rules?\" -> GET /api/pvt/rules\n- \"Create a rule?\" -> POST /api/pvt/rules\n- \"Get rule details?\" -> GET /api/pvt/rules/{ruleId}\n- \"Update a rule?\" -> PUT /api/pvt/rules/{ruleId}\n- \"Delete a rule?\" -> DELETE /api/pvt/rules/{ruleId}\n- \"List all payment-systems?\" -> GET /api/pvt/merchants/payment-systems\n- \"Get account details?\" -> GET /api/payments/pvt/account/{cardId}\n- \"Create a transaction?\" -> POST /api/pvt/transactions\n- \"Create a payment?\" -> POST /api/payments/transactions/{transactionId}/payments\n- \"Create a additional-data?\" -> POST /api/pvt/transactions/{transactionId}/additional-data\n- \"Create a authorization-request?\" -> POST /api/pvt/transactions/{transactionId}/authorization-request\n- \"Get transaction details?\" -> GET /api/pvt/transactions/{transactionId}\n- \"Get payment details?\" -> GET /api/pvt/transactions/{transactionId}/payments/{paymentId}\n- \"List all settlements?\" -> GET /api/pvt/transactions/{transactionId}/settlements\n- \"Create a settlement-request?\" -> POST /api/pvt/transactions/{transactionId}/settlement-request\n- \"Create a refunding-request?\" -> POST /api/pvt/transactions/{transactionId}/refunding-request\n- \"Create a cancellation-request?\" -> POST /api/pvt/transactions/{transactionId}/cancellation-request\n- \"List all payment-notification?\" -> GET /api/payments/pvt/payments/{paymentId}/payment-notification\n- \"Create a payment-notification?\" -> POST /api/payments/pvt/payments/{paymentId}/payment-notification\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get payments-gateway-api -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search payments-gateway-api\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Payments Gateway API\n@base https://apiexamples.vtexpayments.com.br\n@version 1.0\n@auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n@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.}\n@endpoints 25\n@hint download_for_search\n@toc api(25)\n\n@endpoint GET /api/pvt/installments\n@desc Get installments options\n@required {request.value: int # Value to be divided into installments.}\n@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.}\n@returns(200) {value: num, installments: [map]} # OK\n@errors {400: Bad Request}\n\n@endpoint GET /api/pvt/affiliations\n@desc List all affiliations\n@returns(200) OK\n\n@endpoint POST /api/pvt/affiliations\n@desc Insert new affiliation\n@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.}\n@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK\n@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}\n\n@endpoint PUT /api/pvt/affiliations/{affiliationId}\n@desc Update affiliation by ID\n@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.}\n@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK\n@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}\n\n@endpoint GET /api/pvt/affiliations/{affiliationId}\n@desc Get affiliation by ID\n@required {affiliationId: str # Affiliation (payment or anti-fraud provider) identification.}\n@returns(200) {id: str, implementation: str, name: str, configuration: [map], isdelivered: bool, isConfigured: bool} # OK\n\n@endpoint GET /api/pvt/rules\n@desc List all payment rules\n@returns(200) OK\n\n@endpoint POST /api/pvt/rules\n@desc Insert a new payment rule\n@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.}\n@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.}\n@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\n@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}\n\n@endpoint GET /api/pvt/rules/{ruleId}\n@desc Get payment rule by ID\n@required {ruleId: str # Rule identification.}\n@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\n\n@endpoint PUT /api/pvt/rules/{ruleId}\n@desc Update payment rule by ID\n@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.}\n@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.}\n@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\n@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}\n\n@endpoint DELETE /api/pvt/rules/{ruleId}\n@desc Delete payment rule by ID\n@required {ruleId: str # Rule identification.}\n@returns(200) OK\r \r This endpoint does not return a response body.\n\n@endpoint GET /api/pvt/merchants/payment-systems\n@desc List all available payment methods\n@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.}\n@returns(200) OK\n\n@endpoint GET /api/payments/pvt/account/{cardId}\n@desc Get card data\n@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.}\n@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\n@errors {404: Not Found, 500: Internal Server Error\r \r Payment system not found for the card.}\n\n@endpoint POST /api/pvt/transactions\n@desc Start a new transaction\n@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.}\n@optional {urn: str # [URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.}\n@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\n@example_request {\"value\":20000,\"referenceId\":\"1234567\",\"channel\":\"cosmetics2\",\"urn\":\"urn:amazon:webservices:clientvpn\",\"salesChannel\":\"1\"}\n\n@endpoint POST /api/payments/transactions/{transactionId}/payments\n@desc Send payments information\n@required {an: str # Account name., orderId: str # Order identification., transactionId: str # Transaction identification.}\n@returns(201) Created\r \r This endpoint does not return a response body.\n@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\"}}]\n\n@endpoint POST /api/pvt/transactions/{transactionId}/additional-data\n@desc Send additional data\n@required {transactionId: str # Transaction identification.}\n@returns(200) OK\r \r This endpoint does not return a response body.\n@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\\\"}\"}]\n\n@endpoint PATCH /api/pvt/transactions/{transactionId}/additional-data\n@desc Update additional data\n@required {transactionId: str # Transaction identification.}\n@returns(200) OK\r \r This endpoint does not return a response body.\n@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\\\"}\"}]\n\n@endpoint POST /api/pvt/transactions/{transactionId}/authorization-request\n@desc Authorize new transaction\n@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.}\n@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\n@example_request {\"transactionId\":\"7ECE7DF3EEE14647B05DB904164923E8\",\"softDescriptor\":\"company_name_description_code\",\"prepareForRecurrency\":false}\n\n@endpoint GET /api/pvt/transactions/{transactionId}\n@desc Get transaction details\n@required {transactionId: str # Transaction identification.}\n@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\n\n@endpoint GET /api/pvt/transactions/{transactionId}/payments/{paymentId}\n@desc Get payment details\n@required {transactionId: str # Transaction identification.}\n@optional {paymentId: str # Payment identification.}\n@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\n\n@endpoint GET /api/pvt/transactions/{transactionId}/settlements\n@desc Get transaction settlement details\n@required {transactionId: str # Transaction identification.}\n@returns(200) {requests: [map], actions: [map]} # OK\n\n@endpoint POST /api/pvt/transactions/{transactionId}/settlement-request\n@desc Settle the transaction\n@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.}\n@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\n@example_request {\"value\":10050}\n\n@endpoint POST /api/pvt/transactions/{transactionId}/refunding-request\n@desc Refund the transaction\n@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.}\n@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.}\n@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\n@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}]}}\n\n@endpoint POST /api/pvt/transactions/{transactionId}/cancellation-request\n@desc Cancel the transaction\n@required {transactionId: str # Transaction identification., value: num # Value of the purchase that will be cancelled.}\n@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\n@example_request {\"value\":2300}\n\n@endpoint GET /api/payments/pvt/payments/{paymentId}/payment-notification\n@desc Send payment notification with payment ID\n@required {paymentId: str # Payment identification.}\n@returns(200) OK\n\n@endpoint POST /api/payments/pvt/payments/{paymentId}/payment-notification\n@desc Send payment notification with payment ID, date, and value paid\n@required {paymentId: str # Payment identification., paymentDate: str # Date when the payment was made, in DD/MM/YYYY format., valuePaid: num # Value that was paid.}\n@returns(200) OK\n@example_request {\"paymentDate\":\"01/01/2025\",\"valuePaid\":50.1}\n\n@end\n"}}