{ "openapi": "3.0.0", "info": { "title": "Checkout Custom Card Payment API", "version": "1.0", "description": "The Checkout Custom Card Cayment API allows flows for credit card tokenization in VTEX, covering profile management, card token vault operations, checkout processes, payment gateway interactions, and authentication workflows.\r\n\r\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.", "contact": {} }, "servers": [ { "url": "https://{accountName}.{environment}.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, "environment": { "description": "Environment to use. Used as part of the URL.", "default": "vtexcommercestable" } } } ], "paths": { "/api/profile-system/pvt/profiles": { "post": { "tags": ["Profile management"], "summary": "Create profile", "description": "Creates a new Storefront user profile in the Profile System with personal data and addresses.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-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| Vtex ID | User Management | **Create User** |\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>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["personalData", "addresses"], "properties": { "personalData": { "type": "object", "description": "Personal information of the user.", "required": [ "email", "firstName", "lastName" ], "properties": { "email": { "type": "string", "description": "Email address of the user." }, "firstName": { "type": "string", "description": "First name of the user." }, "lastName": { "type": "string", "description": "Last name of the user." }, "document": { "type": "string", "description": "Document number of the user." }, "documentType": { "type": "string", "description": "Type of document." }, "gender": { "type": "string", "description": "Gender of the user." }, "homePhone": { "type": "string", "description": "Home phone number." }, "cellPhone": { "type": "string", "description": "Cell phone number." }, "businessPhone": { "type": "string", "description": "Business phone number." }, "isPJ": { "type": "boolean", "description": "Indicates if the user is a legal entity." } } }, "addresses": { "type": "object", "description": "Address information for the user.", "additionalProperties": { "type": "object", "description": "Address object containing address details.", "properties": { "addressId": { "type": "string", "description": "Unique identifier for the address." }, "receiverName": { "type": "string", "description": "Name of the person receiving at this address." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "addressType": { "type": "string", "description": "Type of address." }, "postalCode": { "type": "string", "description": "Postal code of the address." }, "street": { "type": "string", "description": "Street name." }, "neighborhood": { "type": "string", "description": "Neighborhood name." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State code." }, "country": { "type": "string", "description": "Country code." }, "number": { "type": "string", "description": "Street number." } } } } } }, "example": { "personalData": { "email": "user@example.com", "firstName": "John", "lastName": "Doe", "document": "01234567890", "documentType": "cpf", "gender": "M", "homePhone": "+5511999999999", "cellPhone": "+5522999999999", "businessPhone": "+5522988888888", "isPJ": false }, "addresses": { "0": { "addressId": "12345678-1234-1234-1234-123456789012", "receiverName": "John Doe", "isDisposable": false, "addressType": "residential", "postalCode": "12345678", "street": "Main Street", "neighborhood": "Downtown", "city": "São Paulo", "state": "SP", "country": "BRA", "number": "123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Profile information.", "properties": { "profileId": { "type": "string", "description": "Unique identifier for the created profile." } } }, "example": { "profileId": "12345678-1234-1234-1234-123456789012" } } } } } } }, "/api/card-token-vault/tokens": { "post": { "tags": ["Card token vault"], "summary": "Save card token", "description": "Saves a new card token to the Card Token Vault.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "providerId", "card", "cardTokenData", "email" ], "properties": { "providerId": { "type": "string", "description": "Identifier of the payment provider." }, "card": { "type": "object", "description": "Card information.", "required": [ "paymentSystemName", "paymentSystemId", "firstDigits", "lastDigits", "holderName" ], "properties": { "paymentSystemName": { "type": "string", "description": "Name of the payment system." }, "paymentSystemId": { "type": "string", "description": "Identifier of the payment system." }, "firstDigits": { "type": "string", "description": "First six digits of the card number." }, "lastDigits": { "type": "string", "description": "Last four digits of the card number." }, "address": { "type": "object", "description": "Billing address information.", "properties": { "addressType": { "type": "string", "description": "Type of address." }, "postalCode": { "type": "string", "description": "Postal code." }, "street": { "type": "string", "description": "Street name." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State code." }, "country": { "type": "string", "description": "Country name." }, "number": { "type": "string", "description": "Street number." } } }, "holderName": { "type": "string", "description": "Name of the cardholder." } } }, "cardTokenData": { "type": "object", "description": "Token data for the card.", "required": [ "type", "value", "expiration" ], "properties": { "type": { "type": "string", "description": "Type of token." }, "value": { "type": "string", "description": "Token value." }, "expiration": { "type": "string", "description": "Expiration date in `YYYY-MM` format." }, "label": { "type": "string", "description": "Label for the card token." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization (`true`) or not (`false`)." } } }, "email": { "type": "string", "description": "Email address associated with the token." } } }, "example": { "providerId": "123579", "card": { "paymentSystemName": "Visa", "paymentSystemId": "2", "firstDigits": "411111", "lastDigits": "1111", "address": { "addressType": "billing", "postalCode": "12345678", "street": "Main Street", "neighborhood": "Downtown", "city": "São Paulo", "state": "SP", "country": "Brazil", "number": "123" }, "holderName": "John Doe" }, "cardTokenData": { "type": "TOKEN_VALUE", "value": "4111111111111111", "expiration": "2030-12", "label": "Primary credit card", "useCvvForAuthorization": false }, "email": "user@example.com" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the saved card token." }, "accountName": { "type": "string", "description": "Account name associated with this token." }, "providerId": { "type": "string", "description": "ID of the payment provider." }, "card": { "type": "object", "description": "Card information.", "properties": { "paymentSystemId": { "type": "string", "description": "ID of the payment system." }, "paymentSystemName": { "type": "string", "description": "Name of the payment system." }, "firstDigits": { "type": "string", "description": "First six digits of the card." }, "lastDigits": { "type": "string", "description": "Last four digits of the card." }, "holderName": { "type": "string", "description": "Cardholder's name." }, "address": { "type": "object", "description": "Billing address linked to the card.", "properties": { "addressType": { "type": "string", "description": "Type of address." }, "addressId": { "type": "string", "description": "Address ID.", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code." }, "street": { "type": "string", "description": "Street name." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "country": { "type": "string", "description": "Country." }, "number": { "type": "string", "description": "Street number." }, "complement": { "type": "string", "description": "Address complement.", "nullable": true } } } } }, "cardTokenData": { "type": "object", "description": "Token information for the card.", "properties": { "type": { "type": "string", "description": "Type of token." }, "expiration": { "type": "string", "description": "Expiration in YYYY-MM format." }, "value": { "type": "string", "description": "Token value." }, "label": { "type": "string", "description": "Label for the tokenized card." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is used for authorization." } } } } }, "example": { "id": "EAA2FC55554448D7B56DE57D9ACDE1B1", "accountName": "gatewayqabrmkt", "providerId": "123579", "card": { "paymentSystemId": "2", "paymentSystemName": "Visa", "firstDigits": "712737", "lastDigits": "4791", "holderName": "Nicole Kuhn", "address": { "addressType": "billing", "addressId": null, "postalCode": "97802532", "street": "61898 Joesph Via", "neighborhood": "Sylvester Stehr", "city": "Emardside", "state": "KO", "country": "British Indian Ocean Territory (Chagos Archipelago)", "number": "4", "complement": null } }, "cardTokenData": { "type": "TOKEN_VALUE", "expiration": "2031-05", "value": "7127376938244791", "label": "01.A. Save 1 tokenized credit card via api using an external credential", "useCvvForAuthorization": false } } } } } } } }, "/api/checkout/pub/orderForm/{orderFormId}/items": { "post": { "tags": ["Checkout operations"], "summary": "Add items to cart", "description": "Adds items to the orderForm.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "orderFormId", "in": "path", "description": "Unique identifier of the orderForm.", "required": true, "schema": { "type": "string", "example": "B0935AF4429441ABB4161111ED9D1104" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["orderItems"], "properties": { "orderItems": { "type": "array", "description": "List of items to add to the cart.", "items": { "type": "object", "description": "Order item details.", "required": [ "id", "seller", "quantity" ], "properties": { "id": { "type": "integer", "description": "SKU ID of the item." }, "seller": { "type": "string", "description": "Seller ID." }, "quantity": { "type": "integer", "description": "Quantity of the item." } } } } } }, "example": { "orderItems": [ { "id": 1, "seller": "1", "quantity": 10 } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderFormId": { "type": "string", "description": "Unique identifier of the orderForm." }, "salesChannel": { "type": "string", "description": "Sales channel through which the order was made." }, "loggedIn": { "type": "boolean", "description": "Whether the user is logged in." }, "isCheckedIn": { "type": "boolean", "description": "Indicates if the client is checked in at a pickup point." }, "storeId": { "type": "string", "nullable": true, "description": "ID of the physical store where the user is checked in, if any." }, "checkedInPickupPointId": { "type": "string", "nullable": true, "description": "ID of the pickup point where the client is checked in, if any." }, "allowManualPrice": { "type": "boolean", "description": "Indicates if manual price is allowed." }, "canEditData": { "type": "boolean", "description": "Specifies if user data can be edited before completing the purchase." }, "userProfileId": { "type": "string", "nullable": true, "description": "ID of the user's profile if available." }, "userType": { "type": "string", "nullable": true, "description": "Type of user (e.g., `'B2C'`, `'B2B'`)." }, "ignoreProfileData": { "type": "boolean", "description": "Indicates if profile data should be ignored for this order." }, "value": { "type": "integer", "description": "Total value of the order (in cents)." }, "messages": { "type": "array", "description": "List of system or business messages associated with the order.", "items": { "type": "string", "description": "Message." } }, "items": { "type": "array", "description": "List of items in the cart.", "items": { "type": "object", "description": "Item details.", "properties": { "uniqueId": { "type": "string", "description": "Unique identifier for the item in the cart." }, "id": { "type": "string", "description": "SKU identifier of the item." }, "productId": { "type": "string", "description": "ID of the product this SKU belongs to." }, "productRefId": { "type": "string", "description": "Reference ID of the product." }, "refId": { "type": "string", "description": "Reference ID of the SKU." }, "ean": { "type": "string", "nullable": true, "description": "EAN (European Article Number) for the SKU." }, "name": { "type": "string", "description": "Name of the product." }, "skuName": { "type": "string", "description": "Name of the SKU." }, "modalType": { "type": "string", "description": "Type of modal that might be associated with the item." }, "parentItemIndex": { "type": "integer", "nullable": true, "description": "Index for the parent item if this is a child item; otherwise, null." }, "parentAssemblyBinding": { "type": "string", "nullable": true, "description": "Assembly binding information for parent item if applicable." }, "assemblies": { "type": "array", "description": "List of assemblies attached to this item.", "items": { "type": "string", "description": "Assembly information." } }, "priceValidUntil": { "type": "string", "format": "date-time", "description": "Date and time until the current price is valid." }, "tax": { "type": "integer", "description": "Tax value for the item (in cents)." }, "price": { "type": "integer", "description": "Price of the item (in cents)." }, "listPrice": { "type": "integer", "description": "Original price of the item (in cents) before discounts." }, "manualPrice": { "type": "number", "nullable": true, "description": "Manual price set for the item, if any." }, "manualPriceAppliedBy": { "type": "string", "nullable": true, "description": "User or system entity who applied the manual price, if any." }, "sellingPrice": { "type": "integer", "description": "Final price at which the item is being sold (in cents)." }, "rewardValue": { "type": "integer", "description": "Reward value for the item (in cents, usually for loyalty or promotion)." }, "isGift": { "type": "boolean", "description": "Whether the item was added as a gift." }, "additionalInfo": { "type": "object", "description": "Additional info for the item.", "properties": { "dimension": { "type": "string", "nullable": true, "description": "Dimension information for the item, if any." }, "brandName": { "type": "string", "description": "Brand name of the product." }, "brandId": { "type": "string", "description": "Identifier for the brand." }, "offeringInfo": { "type": "string", "nullable": true, "description": "Information regarding special offerings, if any." }, "offeringType": { "type": "string", "nullable": true, "description": "Type of special offering, if any." }, "offeringTypeId": { "type": "string", "nullable": true, "description": "ID of special offering type, if any." } } }, "preSaleDate": { "type": "string", "nullable": true, "format": "date-time", "description": "Date until which the item is in pre-sale (if applicable)." }, "productCategoryIds": { "type": "string", "description": "String of IDs for the categories the product belongs to." }, "productCategories": { "type": "object", "description": "Mapping of category IDs to names.", "items": { "type": "string", "description": "Category ID." } }, "quantity": { "type": "integer", "description": "Quantity of the item." }, "seller": { "type": "string", "description": "Identifier for the seller." }, "sellerChain": { "type": "array", "description": "List of sellers in the chain for this item.", "items": { "type": "string", "description": "Seller ID." } }, "imageUrl": { "type": "string", "description": "URL for the item's image." }, "detailUrl": { "type": "string", "description": "URL to the item's detail page." }, "components": { "type": "array", "description": "Item components, if the item is a bundle.", "items": { "type": "string", "description": "Component information." } }, "bundleItems": { "type": "array", "description": "List of bundle items related to this item.", "items": { "type": "string", "description": "Bundle item information." } }, "attachments": { "type": "array", "description": "List of attachments for this item.", "items": { "type": "string", "description": "Attachment information." } }, "attachmentOfferings": { "type": "array", "description": "Attachable offerings to the item.", "items": { "type": "string", "description": "Offering information." } }, "offerings": { "type": "array", "description": "List of available offerings for the item.", "items": { "type": "string", "description": "Offering information." } }, "priceTags": { "type": "array", "description": "List of price tags for the item.", "items": { "type": "string", "description": "Price tag information." } }, "availability": { "type": "string", "description": "Availability status of the item." }, "measurementUnit": { "type": "string", "description": "Unit used for measuring this item (e.g., 'un', 'kg')." }, "unitMultiplier": { "type": "number", "description": "Multiplier that indicates how many units each item represents." }, "manufacturerCode": { "type": "string", "nullable": true, "description": "Code of the manufacturer, if available." }, "priceDefinition": { "type": "object", "description": "Price definition, including selling price and breakdown.", "properties": { "calculatedSellingPrice": { "type": "integer", "description": "Selling price calculated for the item (in cents)." }, "total": { "type": "integer", "description": "Total price for the quantity (in cents)." }, "sellingPrices": { "type": "array", "description": "List with value and quantity for each price segment.", "items": { "type": "object", "description": "Price segment details.", "properties": { "value": { "type": "integer", "description": "Value of the selling price for this segment (in cents)." }, "quantity": { "type": "integer", "description": "Quantity of items for this price segment." } } } }, "reason": { "type": "string", "nullable": true, "description": "Reason for the price, if applicable." } } }, "taxCode": { "type": "string", "description": "Tax code for the item." } } } }, "selectableGifts": { "type": "array", "description": "List of gifts that can be selected by the user.", "items": { "type": "string", "description": "Gift information." } }, "totalizers": { "type": "array", "description": "List of totalizer objects giving a breakdown of the total order amount.", "items": { "type": "object", "description": "Totalizer details.", "properties": { "id": { "type": "string", "description": "Identifier for the totalizer." }, "name": { "type": "string", "description": "Name for the totalizer." }, "value": { "type": "integer", "description": "Total value this totalizer represents (in cents)." } } } }, "shippingData": { "type": "object", "description": "Shipping information for the order.", "properties": { "address": { "type": "object", "nullable": true, "description": "Selected shipping address, or null if not set." }, "logisticsInfo": { "type": "array", "description": "List of logistics options for each cart item.", "items": { "type": "object", "description": "Logistics information for an item.", "properties": { "itemIndex": { "type": "integer", "description": "Index position of the item in the cart." }, "selectedSla": { "type": "string", "nullable": true, "description": "Selected SLA (Shipping Level Agreement) option, if any." }, "selectedDeliveryChannel": { "type": "string", "nullable": true, "description": "Selected delivery channel, if any." }, "addressId": { "type": "string", "nullable": true, "description": "ID of the address being used for delivery." }, "slas": { "type": "array", "description": "List of available SLAs for this item.", "items": { "type": "string", "description": "SLA information." } }, "shipsTo": { "type": "array", "description": "Countries this item can ship to (ISO 3166-1).", "items": { "type": "string", "description": "Country code." } }, "itemId": { "type": "string", "description": "ID of the item in the order." }, "deliveryChannels": { "type": "array", "description": "Delivery channels available for this item.", "items": { "type": "object", "description": "Delivery channel details.", "properties": { "id": { "type": "string", "description": "Identifier for the delivery channel." } } } } } } }, "selectedAddresses": { "type": "array", "description": "Addresses selected for delivery.", "items": { "type": "string", "description": "Address information." } }, "availableAddresses": { "type": "array", "description": "Addresses available to select for delivery.", "items": { "type": "string", "description": "Address information." } }, "pickupPoints": { "type": "array", "description": "List of pickup points available to select.", "items": { "type": "string", "description": "Pickup point information." } }, "contactInformation": { "type": "array", "description": "Contact information objects for delivery.", "items": { "type": "string", "description": "Contact information." } } } }, "clientProfileData": { "type": "object", "nullable": true, "description": "Client profile data (personal details), if available.", "properties": { "email": { "type": "string", "description": "Email address." }, "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "documentType": { "type": "string", "description": "Type of the document informed by the customer." }, "document": { "type": "string", "description": "Document informed by the customer." }, "phone": { "type": "string", "description": "Phone number." }, "corporateName": { "type": "string", "description": "Company name, if the customer is a legal entity." }, "tradeName": { "type": "string", "description": "Trade name, if the customer is a legal entity." }, "corporateDocument": { "type": "string", "description": "Company document, if the customer is a legal entity." }, "stateInscription": { "type": "string", "description": "State inscription, if the customer is a legal entity." }, "corporatePhone": { "type": "string", "description": "Company phone number, if the customer is a legal entity." }, "isCorporate": { "type": "boolean", "description": "Whether the customer is a legal entity." }, "userProfileId": { "type": "string", "description": "User profile ID." }, "customerClass": { "type": "string", "description": "Customer class." } } }, "paymentData": { "type": "object", "description": "Object containing payment information for the order.", "properties": { "updateStatus": { "type": "string", "description": "Status of the last payment data update." }, "installmentOptions": { "type": "array", "description": "List of installment payment options available.", "items": { "description": "Installment option details.", "type": "object", "properties": { "paymentSystem": { "type": "string", "description": "Identifier for the payment system (as string)." }, "bin": { "type": "string", "nullable": true, "description": "BIN (Bank Identification Number) or null." }, "paymentName": { "type": "string", "nullable": true, "description": "Name of the payment, if available." }, "paymentGroupName": { "type": "string", "nullable": true, "description": "Name of the payment group." }, "value": { "type": "integer", "description": "Total value for this payment method option (in cents)." }, "installments": { "type": "array", "description": "Installment options for this payment method.", "items": { "type": "object", "description": "Installment options for this payment method.", "properties": { "count": { "type": "integer", "description": "Number of payment installments." }, "hasInterestRate": { "type": "boolean", "description": "Indicates if this installment has interest." }, "interestRate": { "type": "number", "description": "Interest rate (percentage) for installment." }, "value": { "type": "integer", "description": "Value per installment (in cents)." }, "total": { "type": "integer", "description": "Total value across all installments (in cents)." }, "sellerMerchantInstallments": { "type": "array", "description": "Installment details for each merchant or seller.", "items": { "type": "object", "description": "Seller merchant installment details.", "properties": { "id": { "type": "string", "description": "ID of the merchant or seller." }, "count": { "type": "integer", "description": "How many installments." }, "hasInterestRate": { "type": "boolean", "description": "Whether interest is applied." }, "interestRate": { "type": "number", "description": "Interest rate, if any." }, "value": { "type": "integer", "description": "Installment value for this merchant." }, "total": { "type": "integer", "description": "Installment total for this merchant." } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "List of all available payment systems on the store.", "items": { "type": "object", "description": "Payment system details.", "properties": { "id": { "type": "integer", "description": "Identifier for the payment system." }, "name": { "type": "string", "description": "Name of the payment system." }, "groupName": { "type": "string", "description": "Group name for the payment system." }, "validator": { "type": "object", "description": "Validation patterns and masks for payment details.", "properties": { "regex": { "type": "string", "nullable": true, "description": "Regex for payment field validation, or null." }, "mask": { "type": "string", "nullable": true, "description": "Mask pattern for input fields, or null." }, "cardCodeRegex": { "type": "string", "nullable": true, "description": "Regex for validating the card security code or null." }, "cardCodeMask": { "type": "string", "nullable": true, "description": "Mask for the card code input, or null." }, "weights": { "type": "array", "nullable": true, "description": "Weights to be used for Luhn algorithm or similar, or null.", "items": { "description": "Weight value.", "type": "integer" } }, "useCvv": { "type": "boolean", "description": "Specifies if the payment requires CVV." }, "useExpirationDate": { "type": "boolean", "description": "Specifies if an expiration date is required." }, "useCardHolderName": { "type": "boolean", "description": "Specifies if cardholder's name is required." }, "useBillingAddress": { "type": "boolean", "description": "Specifies if a billing address is required." } } }, "stringId": { "type": "string", "description": "String identifier for the payment system." }, "template": { "type": "string", "description": "Template identifier for this payment type." }, "requiresDocument": { "type": "boolean", "description": "Whether a document is required." }, "displayDocument": { "type": "boolean", "description": "Whether document field is displayed." }, "isCustom": { "type": "boolean", "description": "Whether this is a custom payment method." }, "description": { "type": "string", "nullable": true, "description": "Description for the payment system, or null." }, "requiresAuthentication": { "type": "boolean", "description": "Whether payment authentication is required." }, "dueDate": { "type": "string", "format": "date-time", "description": "Due date for deferred payments (if any)." }, "availablePayments": { "type": "object", "nullable": true, "description": "Details for available payments, or null." } } } }, "payments": { "type": "array", "description": "List of payment transactions for the order.", "items": { "type": "object", "description": "Payment transaction details.", "properties": { "id": { "type": "string", "description": "ID of the payment transaction." } } } }, "giftCards": { "type": "array", "description": "Gift cards used for payment (if any).", "items": { "type": "string", "description": "Gift card information." } }, "giftCardMessages": { "type": "array", "description": "List of messages relating to gift card payment.", "items": { "type": "string", "description": "Message information." } }, "availableAccounts": { "type": "array", "description": "Payment accounts available to use.", "items": { "type": "object", "description": "Payment account information.", "properties": { "accountId": { "type": "string", "description": "Account identifier." }, "paymentSystem": { "type": "string", "description": "Payment system identifier." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "cardNumber": { "type": "string", "description": "Masked card number." }, "bin": { "type": "string", "description": "Bank identification number." }, "availableAddresses": { "type": "array", "description": "Available addresses for this account.", "items": { "type": "string", "description": "Address identifier." } }, "expirationDate": { "type": "string", "description": "Card expiration date." }, "isExpired": { "type": "boolean", "description": "Indicates if the card is expired." }, "accountStatus": { "type": "string", "nullable": true, "description": "Account status." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization." }, "isCardToken": { "type": "boolean", "description": "Indicates if this is a card token." }, "cardLabel": { "type": "string", "description": "Card label." }, "cardOrigin": { "type": "string", "description": "Card origin." } } } }, "availableTokens": { "type": "array", "description": "Payment tokens available to use.", "items": { "type": "string", "description": "Payment token information." } }, "availableAssociations": { "type": "object", "description": "Associations of available payments.", "properties": { "id": { "type": "string", "description": "ID of the association." } } } } }, "marketingData": { "type": "object", "nullable": true, "description": "Marketing data (UTM parameters, campaigns, etc)." }, "sellers": { "type": "array", "description": "List of sellers involved in the order.", "items": { "type": "object", "description": "Seller information.", "properties": { "id": { "type": "string", "description": "Seller ID." }, "name": { "type": "string", "description": "Seller's name." }, "logo": { "type": "string", "description": "Seller's logo URL." }, "minimumOrderValue": { "type": "integer", "description": "Minimum value for orders from this seller (in cents)." } } } }, "clientPreferencesData": { "type": "object", "description": "Client preferences, such as locale and opt-in status.", "properties": { "locale": { "type": "string", "description": "Locale selected by the client (e.g. pt-BR)." }, "optinNewsLetter": { "type": "boolean", "nullable": true, "description": "Whether client has opted in to newsletter." }, "savePersonalData": { "type": "boolean", "description": "Whether to save client's personal data." }, "savePaymentData": { "type": "boolean", "description": "Whether to allow client's payment data to be saved." } } }, "commercialConditionData": { "type": "object", "nullable": true, "description": "Commercial condition data for the order if any." }, "storePreferencesData": { "type": "object", "description": "Preferences and settings for the store processing the order.", "properties": { "countryCode": { "type": "string", "description": "Store's country code (ISO 3166-1)." }, "saveUserData": { "type": "boolean", "description": "Flag to indicate if the user's data should be saved." }, "timeZone": { "type": "string", "description": "Time zone for the store." }, "currencyCode": { "type": "string", "description": "The ISO code of the store's currency." }, "currencyLocale": { "type": "integer", "description": "Locale code for formatting currency." }, "currencySymbol": { "type": "string", "description": "Symbol used for the currency." }, "currencyFormatInfo": { "type": "object", "description": "Formatting conventions for the store's currency.", "properties": { "currencyDecimalDigits": { "type": "integer", "description": "Number of decimal digits for currency formatting." }, "currencyDecimalSeparator": { "type": "string", "description": "Decimal separator for currency formatting." }, "currencyGroupSeparator": { "type": "string", "description": "Group separator for currency formatting." }, "currencyGroupSize": { "type": "integer", "description": "Number of digits in each group." }, "startsWithCurrencySymbol": { "type": "boolean", "description": "Whether the currency symbol appears before the value." } } } } }, "giftRegistryData": { "type": "object", "nullable": true, "description": "Information about a gift registry if used.", "properties": { "id": { "type": "string", "description": "ID of the gift registry." } } }, "openTextField": { "type": "string", "nullable": true, "description": "Open text field for notes or special instructions." }, "invoiceData": { "type": "object", "nullable": true, "description": "Invoice data object if provided." }, "customData": { "type": "object", "description": "Customer additional information.", "nullable": true, "properties": { "customApps": { "type": "array", "description": "Customizable apps created by the store.", "nullable": true, "items": { "type": "object", "description": "Customizable apps details.", "nullable": true } }, "customFields": { "type": "array", "description": "Customizable fields created by the store.", "nullable": true, "items": { "type": "object", "description": "Customizable fields details.", "nullable": true, "properties": { "linkedEntity": { "type": "object", "description": "Linked entity.", "properties": { "type": { "type": "string", "description": "Linked entity type.", "enum": ["order", "item", "address"] }, "id": { "type": "string", "description": "Linked entity ID." } } }, "fields": { "type": "array", "description": "Custom fields.", "items": { "type": "object", "description": "Custom fields details.", "properties": { "name": { "type": "string", "description": "Custom field name." }, "value": { "type": "string", "description": "Custom field value." }, "refId": { "type": "string", "description": "Custom field reference ID." } } } } } } } } }, "itemMetadata": { "type": "object", "description": "Metadata information for each item in the order.", "properties": { "items": { "type": "array", "description": "Metadata and detail information for items.", "items": { "type": "object", "description": "Item metadata details.", "properties": { "id": { "type": "string", "description": "SKU identifier of the item." }, "seller": { "type": "string", "description": "Seller identifier." }, "name": { "type": "string", "description": "Product name." }, "skuName": { "type": "string", "description": "SKU name." }, "productId": { "type": "string", "description": "Product identifier." }, "refId": { "type": "string", "description": "Reference ID of the SKU." }, "ean": { "type": "string", "nullable": true, "description": "EAN (European Article Number) for the SKU." }, "imageUrl": { "type": "string", "description": "Image URL representing the product." }, "detailUrl": { "type": "string", "description": "URL for the product detail page." }, "assemblyOptions": { "type": "array", "description": "Possible assembly options for the SKU.", "items": { "type": "object", "description": "Assembly option details.", "properties": { "id": { "type": "string", "description": "ID of the assembly option." } } } } } } } } }, "hooksData": { "type": "object", "nullable": true, "description": "Information about hooks processed during the order." }, "ratesAndBenefitsData": { "type": "object", "description": "Data on rates (discounts, promotions) and associated benefits.", "properties": { "rateAndBenefitsIdentifiers": { "type": "array", "description": "List of identifiers for the applied rates and benefits.", "items": { "type": "object", "description": "Rate and benefit identifier details.", "properties": { "id": { "type": "string", "description": "ID of the rate and benefit identifier." } } } }, "teaser": { "type": "array", "description": "Teaser data for current order's benefits.", "items": { "type": "object", "description": "Teaser details.", "properties": { "id": { "type": "string", "description": "ID of the teaser." } } } } } }, "subscriptionData": { "type": "object", "nullable": true, "description": "Subscription information attached to the order, if any." }, "merchantContextData": { "type": "object", "nullable": true, "description": "Merchant context custom data, if any." }, "purchaseAgentsData": { "type": "object", "nullable": true, "description": "Data about purchase agents related to the order." }, "itemsOrdination": { "type": "object", "nullable": true, "description": "Metadata information on item ordination (sorting) in the order." } } }, "example": { "orderFormId": "BDEC98E315344E26915ABC6CAB801C7E", "salesChannel": "1", "loggedIn": true, "isCheckedIn": false, "storeId": null, "checkedInPickupPointId": null, "allowManualPrice": false, "canEditData": true, "userProfileId": null, "userType": null, "ignoreProfileData": false, "value": 20000, "messages": [], "items": [ { "uniqueId": "542B8DF821E14D67BA09722601029B4F", "id": "1", "productId": "1", "productRefId": "ref123456", "refId": "ref123456", "ean": null, "name": "Produto Teste SKU Teste", "skuName": "SKU Teste", "modalType": "", "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": "2026-12-19T17:23:25Z", "tax": 0, "price": 2000, "listPrice": 2000, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": 2000, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": "Brand name", "brandId": "2000000", "offeringInfo": null, "offeringType": null, "offeringTypeId": null }, "preSaleDate": null, "productCategoryIds": "/1/", "productCategories": { "1": "Category" }, "quantity": 10, "seller": "1", "sellerChain": [ "1" ], "imageUrl": "https://gatewayqabrmkt.vteximg.com.br/arquivos/ids/155394-55-55/imagem produto.jpg.jpg?v=638826675586530000", "detailUrl": "/produto-teste/p", "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": "available", "measurementUnit": "un", "unitMultiplier": 1.0000, "manufacturerCode": null, "priceDefinition": { "calculatedSellingPrice": 2000, "total": 20000, "sellingPrices": [ { "value": 2000, "quantity": 10 } ], "reason": null }, "taxCode": "" } ], "selectableGifts": [], "totalizers": [ { "id": "Items", "name": "Total dos Itens", "value": 20000 } ], "shippingData": { "address": null, "logisticsInfo": [ { "itemIndex": 0, "selectedSla": null, "selectedDeliveryChannel": null, "addressId": null, "slas": [], "shipsTo": [ "BRA", "USA" ], "itemId": "1", "deliveryChannels": [ { "id": "delivery" } ] } ], "selectedAddresses": [], "availableAddresses": [], "pickupPoints": [], "contactInformation": [] }, "clientProfileData": null, "paymentData": { "updateStatus": "updated", "installmentOptions": [ { "paymentSystem": "1", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": "2", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000 } ] }, { "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000 } ] }, { "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000 } ] }, { "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000 } ] }, { "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000 } ] }, { "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000 } ] }, { "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000 } ] }, { "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000 } ] }, { "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000 } ] } ] }, { "paymentSystem": "3", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000 } ] }, { "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000 } ] }, { "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000 } ] }, { "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000 } ] }, { "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000 } ] }, { "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000 } ] }, { "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000 } ] }, { "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000 } ] }, { "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000 } ] } ] }, { "paymentSystem": "16", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": "169", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": "201", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": "900", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] } ], "paymentSystems": [ { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^4[0-9]{15}$", "mask": "9999 9999 9999 9999", "cardCodeRegex": "^[0-9]{3}$", "cardCodeMask": "999", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361553Z", "availablePayments": null }, { "id": 201, "name": "Promissory", "groupName": "custom201PaymentGroupPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "201", "template": "custom201PaymentGroupPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": true, "description": "Promissory Description", "requiresAuthentication": false, "dueDate": "2025-12-26T17:23:25.9361555Z", "availablePayments": null }, { "id": 3, "name": "Diners", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^3(0[0-5]|[68][0-9])[0-9]{11}$", "mask": "9999 999999 9999", "cardCodeRegex": "^[0-9]{3}$", "cardCodeMask": "999", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "3", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361556Z", "availablePayments": null }, { "id": 16, "name": "Vale", "groupName": "giftCardPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "16", "template": "giftCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361556Z", "availablePayments": null }, { "id": 169, "name": "Google Pay", "groupName": "Google PayPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "169", "template": "Google PayPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361557Z", "availablePayments": null }, { "id": 1, "name": "American Express", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^3[47][0-9]{13}$", "mask": "9999 999999 99999", "cardCodeRegex": "^[0-9]{4}$", "cardCodeMask": "9999", "weights": [ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "1", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": true, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361557Z", "availablePayments": null }, { "id": 900, "name": "WH Google Pay", "groupName": "WH Google PayPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "900", "template": "WH Google PayPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2025-12-26T17:22:25.9361557Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [ { "accountId": "4A660C0DEA2D477C996D88C6D3FFB7C0", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "22343544", "availableAddresses": [ "12345" ], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": false, "isCardToken": true }, { "accountId": "7E49E29225E643C6817FC80AA5FA6EC1", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "223433", "availableAddresses": [], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": true, "cardLabel": "label teste shopper", "isCardToken": false, "cardOrigin": "shopper" } ], "availableTokens": [], "availableAssociations": {} }, "marketingData": null, "sellers": [ { "id": "1", "name": "Gateway Payments", "logo": "", "minimumOrderValue": 5000 } ], "clientPreferencesData": { "locale": "pt-BR", "optinNewsLetter": null, "savePersonalData": false, "savePaymentData": false }, "commercialConditionData": null, "storePreferencesData": { "countryCode": "BRA", "saveUserData": true, "timeZone": "E. South America Standard Time", "currencyCode": "BRL", "currencyLocale": 1046, "currencySymbol": "R$", "currencyFormatInfo": { "currencyDecimalDigits": 2, "currencyDecimalSeparator": ",", "currencyGroupSeparator": ".", "currencyGroupSize": 3, "startsWithCurrencySymbol": true } }, "giftRegistryData": null, "openTextField": null, "invoiceData": null, "customData": null, "itemMetadata": { "items": [ { "id": "1", "seller": "1", "name": "Produto Teste SKU Teste", "skuName": "SKU Teste", "productId": "1", "refId": "ref123456", "ean": null, "imageUrl": "https://gatewayqabrmkt.vteximg.com.br/arquivos/ids/155394-55-55/imagem produto.jpg.jpg?v=638826675586530000", "detailUrl": "/produto-teste/p", "assemblyOptions": [] } ] }, "hooksData": null, "ratesAndBenefitsData": { "rateAndBenefitsIdentifiers": [], "teaser": [] }, "subscriptionData": null, "merchantContextData": null, "purchaseAgentsData": null, "itemsOrdination": null } } } } } } }, "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData": { "post": { "tags": ["Checkout operations"], "summary": "Add client profile data", "description": "Attaches client profile data to the orderForm.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "orderFormId", "in": "path", "description": "Unique identifier of the orderForm.", "required": true, "schema": { "type": "string", "example": "B0935AF4429441ABB4161111ED9D1104" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["email"], "properties": { "email": { "type": "string", "description": "Email address of the client.", "example": "user@example.com" } } }, "example": { "email": "user@example.com" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderFormId": { "type": "string", "description": "Unique identifier of the orderForm." }, "salesChannel": { "type": "string", "description": "Sales channel identifier." }, "loggedIn": { "type": "boolean", "description": "Indicates if the user is logged in." }, "isCheckedIn": { "type": "boolean", "description": "Indicates if the user is checked in." }, "storeId": { "type": "string", "nullable": true, "description": "Store identifier." }, "checkedInPickupPointId": { "type": "string", "nullable": true, "description": "Checked-in pickup point identifier." }, "allowManualPrice": { "type": "boolean", "description": "Indicates if manual price is allowed." }, "canEditData": { "type": "boolean", "description": "Indicates if data can be edited." }, "userProfileId": { "type": "string", "description": "User profile identifier.", "nullable": true }, "userType": { "type": "string", "nullable": true, "description": "User type." }, "ignoreProfileData": { "type": "boolean", "description": "Indicates if profile data should be ignored." }, "value": { "type": "number", "description": "Total value of the order." }, "messages": { "type": "array", "description": "List of messages.", "items": { "type": "object", "description": "Message information.", "properties": { "message": { "type": "string", "description": "Message." } } } }, "items": { "type": "array", "description": "List of items in the order.", "items": { "type": "object", "description": "Item information.", "properties": { "id": { "type": "string", "description": "Identifier for the item." } } } }, "selectableGifts": { "type": "array", "description": "List of selectable gifts.", "items": { "type": "object", "description": "Selectable gift information.", "properties": { "id": { "type": "string", "description": "Identifier for the selectable gift." } } } }, "totalizers": { "type": "array", "description": "List of totalizers.", "items": { "type": "object", "description": "Totalizer information.", "properties": { "id": { "type": "string", "description": "Identifier for the totalizer." }, "name": { "type": "string", "description": "Name for the totalizer." } } } }, "shippingData": { "type": "object", "description": "Shipping data.", "properties": { "address": { "type": "object", "description": "Address information.", "nullable": true, "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } }, "logisticsInfo": { "type": "array", "description": "List of logistics information.", "items": { "type": "object", "description": "Logistics information.", "properties": { "id": { "type": "string", "description": "Identifier for the logistics information." } } } }, "selectedAddresses": { "type": "array", "description": "List of selected addresses.", "items": { "type": "object", "description": "Selected address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Coordinate value." } } } } }, "availableAddresses": { "type": "array", "description": "List of available addresses.", "items": { "type": "object", "description": "Available address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } } }, "pickupPoints": { "type": "array", "description": "List of pickup points.", "items": { "type": "object", "description": "Pickup point information.", "properties": { "id": { "type": "string", "description": "Identifier for the pickup point." } } } }, "contactInformation": { "type": "array", "description": "List of contact information.", "items": { "type": "object", "description": "Contact information.", "properties": { "id": { "type": "string", "description": "Identifier for the contact information." } } } } } }, "clientProfileData": { "type": "object", "description": "Client profile data.", "nullable": true, "properties": { "email": { "type": "string", "description": "Email address." }, "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "document": { "type": "string", "description": "Document number." }, "documentType": { "type": "string", "description": "Document type." }, "phone": { "type": "string", "description": "Phone number." }, "corporateName": { "type": "string", "nullable": true, "description": "Corporate name." }, "tradeName": { "type": "string", "nullable": true, "description": "Trade name." }, "corporateDocument": { "type": "string", "nullable": true, "description": "Corporate document." }, "stateInscription": { "type": "string", "nullable": true, "description": "State inscription." }, "corporatePhone": { "type": "string", "nullable": true, "description": "Corporate phone." }, "isCorporate": { "type": "boolean", "description": "Indicates if the profile is corporate." }, "profileCompleteOnLoading": { "type": "boolean", "description": "Indicates if the profile is complete on loading." }, "profileErrorOnLoading": { "type": "boolean", "description": "Indicates if there was an error loading the profile." }, "customerClass": { "type": "string", "nullable": true, "description": "Customer class." } } }, "paymentData": { "type": "object", "description": "Payment data.", "properties": { "updateStatus": { "type": "string", "description": "Update status." }, "installmentOptions": { "type": "array", "description": "List of Installment options.", "items": { "type": "object", "description": "Information about the installment option.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system identification." }, "bin": { "type": "string", "description": "Card bin.", "nullable": true }, "paymentName": { "type": "string", "description": "Payment name.", "nullable": true }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "nullable": true }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "installments": { "type": "array", "description": "Installment information.", "items": { "type": "object", "description": "Installment information.", "properties": { "count": { "type": "integer", "description": "Count information." }, "hasInterestRate": { "type": "boolean", "description": "Indicates whether the payment has interest." }, "interestRate": { "type": "integer", "description": "Interest rate value." }, "value": { "type": "integer", "description": "Value of the order without the interest rate. The value is shown without separating cents." }, "total": { "type": "integer", "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`." }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments information.", "items": { "type": "object", "description": "Installment information." } } } } } } } }, "paymentSystems": { "type": "array", "description": "Information on payment systems.", "items": { "type": "object", "description": "Payment system information.", "properties": { "id": { "type": "integer", "description": "Payment system ID." }, "name": { "type": "string", "description": "Payment system name." }, "groupName": { "type": "string", "description": "Payment group name." }, "validator": { "type": "object", "description": "Payment system validator.", "nullable": true }, "stringId": { "type": "string", "description": "String ID." }, "template": { "type": "string", "description": "Template." }, "requiresDocument": { "type": "boolean", "description": "Indicates whether a document is required." }, "displayDocument": { "type": "boolean", "description": "Indicates whether a document is shown." }, "isCustom": { "type": "boolean", "description": "Indicates whether it is custom." }, "description": { "type": "string", "description": "Description." }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether a authentication is required." }, "dueDate": { "type": "string", "description": "Payment due date." }, "availablePayments": { "type": "string", "description": "Availability of payment.", "nullable": true } } } }, "payments": { "type": "array", "description": "Array with information on each payment chosen by the shopper.", "items": { "type": "object", "description": "Payment information.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system ID." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "group": { "type": "string", "description": "Payment system group." }, "installments": { "type": "integer", "description": "Selected number of installments." }, "installmentsInterestRate": { "type": "number", "description": "Installments' interest rate." }, "installmentsValue": { "type": "integer", "description": "Value of the installments." }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "referenceValue": { "type": "integer", "description": "Reference value used to calculate total order value with interest." }, "hasDefaultBillingAddress": { "type": "boolean", "description": "Indicates whether billing address for this payment is the default address." } } } }, "giftCards": { "type": "array", "description": "Gift card information, if it applies to the order.", "items": { "type": "string", "description": "Gift card." } }, "giftCardMessages": { "type": "array", "description": "Array of gift card messages.", "items": { "type": "string", "description": "Gift card message." } }, "availableAccounts": { "type": "array", "description": "Available accounts.", "items": { "type": "object", "description": "Available account.", "properties": { "accountId": { "type": "string", "description": "Account identifier." }, "paymentSystem": { "type": "string", "description": "Payment system identifier." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "cardNumber": { "type": "string", "description": "Masked card number." }, "bin": { "type": "string", "description": "Bank identification number." }, "availableAddresses": { "type": "array", "description": "Available addresses for this account.", "items": { "type": "string", "description": "Address identifier." } }, "expirationDate": { "type": "string", "description": "Card expiration date." }, "isExpired": { "type": "boolean", "description": "Indicates if the card is expired." }, "accountStatus": { "type": "string", "nullable": true, "description": "Account status." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization." }, "isCardToken": { "type": "boolean", "description": "Indicates if this is a card token." }, "cardLabel": { "type": "string", "description": "Card label." }, "cardOrigin": { "type": "string", "description": "Card origin." } } } }, "availableTokens": { "type": "array", "description": "Available tokens.", "items": { "type": "string", "description": "Available token." } }, "availableAssociations": { "type": "object", "description": "Available associations.", "properties": { "id": { "type": "string", "description": "Identifier for the association." } } } } }, "marketingData": { "type": "object", "nullable": true, "description": "Marketing data." }, "sellers": { "type": "array", "description": "Information on each seller.", "items": { "description": "Seller information.", "type": "object", "properties": { "id": { "type": "string", "description": "Seller ID." }, "name": { "type": "string", "description": "Seller name." }, "logo": { "type": "string", "description": "Seller logo.", "nullable": true } } } }, "clientPreferencesData": { "type": "object", "description": "Client preferences data.", "properties": { "locale": { "type": "string", "description": "Locale." }, "optinNewsLetter": { "type": "boolean", "description": "Indicates whether the user opted in to receive the store's newsletter (`true`) or not (`false`)." }, "savePersonalData": { "type": "boolean", "description": "Indicates if personal data should be saved." }, "savePaymentData": { "type": "boolean", "description": "Indicates if payment data should be saved." } } }, "commercialConditionData": { "type": "object", "description": "Object containing commercial condition information.", "nullable": true }, "storePreferencesData": { "type": "object", "description": "Store preferences data.", "properties": { "countryCode": { "type": "string", "description": "Country code." }, "saveUserData": { "type": "boolean", "description": "Indicates if user data should be saved." }, "timeZone": { "type": "string", "description": "Time zone." }, "currencyCode": { "type": "string", "description": "Currency code." }, "currencyLocale": { "type": "number", "description": "Currency locale." }, "currencySymbol": { "type": "string", "description": "Currency symbol." }, "currencyFormatInfo": { "type": "object", "description": "Currency format information.", "properties": { "currencyDecimalDigits": { "type": "number", "description": "Currency decimal digits." }, "currencyDecimalSeparator": { "type": "string", "description": "Currency decimal separator." }, "currencyGroupSeparator": { "type": "string", "description": "Currency group separator." }, "currencyGroupSize": { "type": "number", "description": "Currency group size." }, "startsWithCurrencySymbol": { "type": "boolean", "description": "Indicates if starts with currency symbol." } } } } }, "giftRegistryData": { "type": "object", "description": "Gift registry list information.", "nullable": true }, "openTextField": { "type": "string", "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).", "nullable": true }, "invoiceData": { "type": "object", "description": "Invoice data including billing address.", "nullable": true, "properties": { "address": { "type": "object", "description": "Billing address.", "properties": { "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State name." }, "country": { "type": "string", "description": "Country." }, "street": { "type": "string", "description": "Street name." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "description": "Address complement." }, "reference": { "type": "string", "description": "Reference for location." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates (latitude, longitude).", "items": { "type": "number", "description": "Coordinate value." } } } } } }, "customData": { "type": "object", "description": "Customer additional information.", "nullable": true }, "itemMetadata": { "type": "object", "description": "Item metadata.", "nullable": true, "properties": { "items": { "type": "array", "description": "List of objects containing metadata on each item in the order.", "items": { "description": "Item metadata.", "nullable": true, "type": "object", "properties": { "id": { "type": "string", "description": "Item ID." }, "seller": { "type": "string", "description": "Seller." }, "name": { "type": "string", "description": "Product name." }, "skuName": { "type": "string", "description": "SKU name." }, "productId": { "type": "string", "description": "Product ID." }, "refId": { "type": "string", "description": "Ref ID." }, "ean": { "type": "string", "description": "European Article Number.", "nullable": true }, "imageUrl": { "type": "string", "description": "Image URL." }, "detailUrl": { "type": "string", "description": "Detail URL." } } } } } }, "hooksData": { "type": "object", "description": "Hooks information.", "nullable": true }, "ratesAndBenefitsData": { "type": "object", "description": "Information on rates and benefits that apply to the order.", "properties": { "rateAndBenefitsIdentifiers": { "type": "array", "description": "List with rates and benefits identifiers.", "items": { "type": "string", "description": "Benefit identifier." } }, "teaser": { "type": "array", "description": "List with rates and benefits teasers.", "items": { "type": "string", "description": "Benefit teaser." } } } }, "subscriptionData": { "type": "object", "description": "Subscription information.", "nullable": true }, "merchantContextData": { "type": "object", "nullable": true, "description": "Merchant context data." }, "purchaseAgentsData": { "type": "object", "nullable": true, "description": "Purchase agents data." }, "itemsOrdination": { "type": "object", "description": "Object containing information about the ordering of items within the orderForm.", "nullable": true, "properties": { "criteria": { "type": "string", "description": "Criteria adopted to order the items in the list." }, "ascending": { "type": "boolean", "description": "Indicates whether the ordering is ascending." } } } } }, "example": { "orderFormId": "B0935AF4429441ABB4161111ED9D1104", "salesChannel": "1", "loggedIn": false, "isCheckedIn": false, "storeId": null, "checkedInPickupPointId": null, "allowManualPrice": false, "canEditData": false, "userProfileId": "46a42745-664f-48d2-ae33-76cd1dec5bde", "userType": null, "ignoreProfileData": false, "value": 0, "messages": [], "items": [], "selectableGifts": [], "totalizers": [], "shippingData": { "address": { "addressType": "residential", "receiverName": "C*** S*** I***", "addressId": "0", "isDisposable": false, "editable": false, "postalCode": "***44", "city": "Ran***", "state": "*I", "country": "BRA", "street": "163*** *** ***mon", "number": "***", "neighborhood": "Edm*** ***", "complement": null, "reference": null, "geoCoordinates": [] }, "logisticsInfo": [], "selectedAddresses": [ { "addressType": "residential", "receiverName": "C*** S*** I***", "addressId": "0", "isDisposable": false, "editable": false, "postalCode": "***44", "city": "Ran***", "state": "*I", "country": "BRA", "street": "163*** *** ***mon", "number": "***", "neighborhood": "Edm*** ***", "complement": null, "reference": null, "geoCoordinates": [] } ], "availableAddresses": [ { "addressType": "residential", "receiverName": "C*** S*** I***", "addressId": "0", "isDisposable": false, "editable": false, "postalCode": "***44", "city": "Ran***", "state": "*I", "country": "BRA", "street": "163*** *** ***mon", "number": "***", "neighborhood": "Edm*** ***", "complement": null, "reference": null, "geoCoordinates": [] } ], "pickupPoints": [], "contactInformation": [] }, "clientProfileData": { "email": "fonihi3245@daxiake.com", "firstName": "K***", "lastName": "K***", "document": "***90", "documentType": "cpf", "phone": "***21", "corporateName": null, "tradeName": null, "corporateDocument": null, "stateInscription": null, "corporatePhone": null, "isCorporate": false, "profileCompleteOnLoading": true, "profileErrorOnLoading": false, "customerClass": null }, "paymentData": { "updateStatus": "updated", "installmentOptions": [], "paymentSystems": [], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [ { "accountId": "4A660C0DEA2D477C996D88C6D3FFB7C0", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "22343544", "availableAddresses": [ "12345" ], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": false, "isCardToken": true }, { "accountId": "7E49E29225E643C6817FC80AA5FA6EC1", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "223433", "availableAddresses": [], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": true, "cardLabel": "label teste shopper", "isCardToken": false, "cardOrigin": "shopper" } ], "availableTokens": [], "availableAssociations": {} }, "marketingData": null, "sellers": [], "clientPreferencesData": { "locale": "pt-BR", "optinNewsLetter": false, "savePersonalData": false, "savePaymentData": false }, "commercialConditionData": null, "storePreferencesData": { "countryCode": "BRA", "saveUserData": true, "timeZone": "E. South America Standard Time", "currencyCode": "BRL", "currencyLocale": 1046, "currencySymbol": "R$", "currencyFormatInfo": { "currencyDecimalDigits": 2, "currencyDecimalSeparator": ",", "currencyGroupSeparator": ".", "currencyGroupSize": 3, "startsWithCurrencySymbol": true } }, "giftRegistryData": null, "openTextField": null, "invoiceData": null, "customData": null, "itemMetadata": null, "hooksData": null, "ratesAndBenefitsData": { "rateAndBenefitsIdentifiers": [], "teaser": [] }, "subscriptionData": null, "merchantContextData": null, "purchaseAgentsData": null, "itemsOrdination": null } } } } } } }, "/api/vtexid/pub/authentication/startlogin": { "post": { "tags": ["Authentication"], "summary": "Start client login", "description": "Initiates the authentication process for a user.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK" } } } }, "/api/vtexid/pub/authentication/classic/validate": { "post": { "tags": ["Authentication"], "summary": "Validate client login", "description": "Validates user credentials and returns authentication cookies.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "an", "in": "query", "description": "Account name parameter.", "required": true, "schema": { "type": "string", "example": "apiexamples" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": ["login", "password"], "properties": { "login": { "type": "string", "description": "User email address.", "example": "user@example.com" }, "password": { "type": "string", "description": "User password.", "example": "Password123" } } }, "example": { "login": "user@example.com", "password": "Password123" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "authStatus": { "type": "string", "description": "Authentication status." }, "promptMFA": { "type": "boolean", "description": "Indicates if multi-factor authentication should be prompted." }, "lastAttemptAvailable": { "type": "string", "nullable": true, "description": "Last attempt available." }, "clientToken": { "type": "string", "nullable": true, "description": "Client token." }, "authCookie": { "type": "object", "description": "Authentication cookie information.", "properties": { "Name": { "type": "string", "description": "Cookie name." }, "Value": { "type": "string", "description": "Cookie value." } } }, "accountAuthCookie": { "type": "object", "description": "Account authentication cookie information.", "properties": { "Name": { "type": "string", "description": "Cookie name." }, "Value": { "type": "string", "description": "Cookie value." } } }, "expiresIn": { "type": "integer", "description": "Expiration time in seconds." }, "userId": { "type": "string", "description": "User identifier." }, "phoneNumber": { "type": "string", "nullable": true, "description": "Phone number." }, "scope": { "type": "string", "nullable": true, "description": "Scope." } } }, "example": { "authStatus": "Success", "promptMFA": false, "lastAttemptAvailable": null, "clientToken": null, "authCookie": { "Name": "VtexIdclientAutCookie_gatewayqabrmkt", "Value": "" }, "accountAuthCookie": { "Name": "VtexIdclientAutCookie_example", "Value": "" }, "expiresIn": 86399, "userId": "", "phoneNumber": null, "scope": null } } } } } } }, "/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData": { "post": { "tags": ["Checkout operations"], "summary": "Add payment data", "description": "Attaches payment information to the orderForm.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\r\n\r\n## Storefront permissions\r\n\r\nThe storefront user logged in using endpoint [Validate client login](https:\/\/developers.vtex.com\/docs\/api-reference\/checkout-custom-card-payment-api#post-\/api\/vtexid\/pub\/authentication\/classic\/validate) must have a storefront role with the following [storefront permissions](https:\/\/developers.vtex.com\/docs\/guides\/storefront-permissions) to be able to successfully run this request.\r\n\r\n| Resource key | Predefined storefront role |\r\n| - | - |\r\n| UseAdHocCard | Personal Cards User |", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "orderFormId", "in": "path", "description": "Unique identifier of the orderForm.", "required": true, "schema": { "type": "string", "example": "B0935AF4429441ABB4161111ED9D1104" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["payments"], "properties": { "payments": { "type": "array", "description": "List of payment methods.", "items": { "type": "object", "description": "Payment method details.", "required": [ "paymentSystem", "value", "installments" ], "properties": { "hasDefaultBillingAddress": { "type": "boolean", "description": "Indicates if default billing address should be used." }, "installmentsInterestRate": { "type": "number", "description": "Interest rate for installments.", "nullable": true }, "referenceValue": { "type": "integer", "description": "Reference value in cents." }, "bin": { "type": "string", "description": "Bank Identification Number (first 6 digits of card)." }, "accountId": { "type": "string", "description": "Account ID for saved payment method." }, "value": { "type": "integer", "description": "Payment value in cents." }, "paymentSystem": { "type": "string", "description": "Payment system ID." }, "installments": { "type": "integer", "description": "Number of installments." } } } } } }, "example": { "payments": [ { "hasDefaultBillingAddress": true, "installmentsInterestRate": null, "referenceValue": 20100, "bin": "223435", "accountId": "4A660C0DEA2D477C996D88C6D3FFB7C0", "value": 20100, "paymentSystem": "2", "installments": 1 } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderFormId": { "type": "string", "description": "Unique identifier of the orderForm." }, "salesChannel": { "type": "string", "description": "Sales channel identifier." }, "loggedIn": { "type": "boolean", "description": "Indicates if the user is logged in." }, "isCheckedIn": { "type": "boolean", "description": "Indicates if the user is checked in." }, "storeId": { "type": "string", "nullable": true, "description": "Store identifier." }, "checkedInPickupPointId": { "type": "string", "nullable": true, "description": "Checked-in pickup point identifier." }, "allowManualPrice": { "type": "boolean", "description": "Indicates if manual price is allowed." }, "canEditData": { "type": "boolean", "description": "Indicates if data can be edited." }, "userProfileId": { "type": "string", "description": "User profile identifier.", "nullable": true }, "userType": { "type": "string", "nullable": true, "description": "User type." }, "ignoreProfileData": { "type": "boolean", "description": "Indicates if profile data should be ignored." }, "value": { "type": "number", "description": "Total value of the order." }, "messages": { "type": "array", "description": "List of messages.", "items": { "type": "object", "description": "Message information.", "properties": { "message": { "type": "string", "description": "Message." } } } }, "items": { "type": "array", "description": "List of items in the order.", "items": { "type": "object", "description": "Item information.", "properties": { "id": { "type": "string", "description": "Identifier for the item." } } } }, "selectableGifts": { "type": "array", "description": "List of selectable gifts.", "items": { "type": "object", "description": "Selectable gift information.", "properties": { "id": { "type": "string", "description": "Identifier for the selectable gift." } } } }, "totalizers": { "type": "array", "description": "List of totalizers.", "items": { "type": "object", "description": "Totalizer information.", "properties": { "id": { "type": "string", "description": "Identifier for the totalizer." }, "name": { "type": "string", "description": "Name for the totalizer." } } } }, "shippingData": { "type": "object", "description": "Shipping data.", "properties": { "address": { "type": "object", "description": "Address information.", "nullable": true, "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } }, "logisticsInfo": { "type": "array", "description": "List of logistics information.", "items": { "type": "object", "description": "Logistics information.", "properties": { "id": { "type": "string", "description": "Identifier for the logistics information." } } } }, "selectedAddresses": { "type": "array", "description": "List of selected addresses.", "items": { "type": "object", "description": "Selected address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Coordinate value." } } } } }, "availableAddresses": { "type": "array", "description": "List of available addresses.", "items": { "type": "object", "description": "Available address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } } }, "pickupPoints": { "type": "array", "description": "List of pickup points.", "items": { "type": "object", "description": "Pickup point information.", "properties": { "id": { "type": "string", "description": "Identifier for the pickup point." } } } }, "contactInformation": { "type": "array", "description": "List of contact information.", "items": { "type": "object", "description": "Contact information.", "properties": { "id": { "type": "string", "description": "Identifier for the contact information." } } } } } }, "clientProfileData": { "type": "object", "description": "Client profile data.", "nullable": true, "properties": { "email": { "type": "string", "description": "Email address." }, "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "document": { "type": "string", "description": "Document number." }, "documentType": { "type": "string", "description": "Document type." }, "phone": { "type": "string", "description": "Phone number." }, "corporateName": { "type": "string", "nullable": true, "description": "Corporate name." }, "tradeName": { "type": "string", "nullable": true, "description": "Trade name." }, "corporateDocument": { "type": "string", "nullable": true, "description": "Corporate document." }, "stateInscription": { "type": "string", "nullable": true, "description": "State inscription." }, "corporatePhone": { "type": "string", "nullable": true, "description": "Corporate phone." }, "isCorporate": { "type": "boolean", "description": "Indicates if the profile is corporate." }, "profileCompleteOnLoading": { "type": "boolean", "description": "Indicates if the profile is complete on loading." }, "profileErrorOnLoading": { "type": "boolean", "description": "Indicates if there was an error loading the profile." }, "customerClass": { "type": "string", "nullable": true, "description": "Customer class." } } }, "paymentData": { "type": "object", "description": "Payment data.", "properties": { "updateStatus": { "type": "string", "description": "Update status." }, "installmentOptions": { "type": "array", "description": "List of Installment options.", "items": { "type": "object", "description": "Information about the installment option.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system identification." }, "bin": { "type": "string", "description": "Card bin.", "nullable": true }, "paymentName": { "type": "string", "description": "Payment name.", "nullable": true }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "nullable": true }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "installments": { "type": "array", "description": "Installment information.", "items": { "type": "object", "description": "Installment information.", "properties": { "count": { "type": "integer", "description": "Count information." }, "hasInterestRate": { "type": "boolean", "description": "Indicates whether the payment has interest." }, "interestRate": { "type": "integer", "description": "Interest rate value." }, "value": { "type": "integer", "description": "Value of the order without the interest rate. The value is shown without separating cents." }, "total": { "type": "integer", "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`." }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments information.", "items": { "type": "object", "description": "Installment information." } } } } } } } }, "paymentSystems": { "type": "array", "description": "Information on payment systems.", "items": { "type": "object", "description": "Payment system information.", "properties": { "id": { "type": "integer", "description": "Payment system ID." }, "name": { "type": "string", "description": "Payment system name." }, "groupName": { "type": "string", "description": "Payment group name." }, "validator": { "type": "object", "description": "Payment system validator.", "nullable": true }, "stringId": { "type": "string", "description": "String ID." }, "template": { "type": "string", "description": "Template." }, "requiresDocument": { "type": "boolean", "description": "Indicates whether a document is required." }, "displayDocument": { "type": "boolean", "description": "Indicates whether a document is shown." }, "isCustom": { "type": "boolean", "description": "Indicates whether it is custom." }, "description": { "type": "string", "description": "Description." }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether a authentication is required." }, "dueDate": { "type": "string", "description": "Payment due date." }, "availablePayments": { "type": "string", "description": "Availability of payment.", "nullable": true } } } }, "payments": { "type": "array", "description": "Array with information on each payment chosen by the shopper.", "items": { "type": "object", "description": "Payment information.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system ID." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "group": { "type": "string", "description": "Payment system group." }, "installments": { "type": "integer", "description": "Selected number of installments." }, "installmentsInterestRate": { "type": "number", "description": "Installments' interest rate." }, "installmentsValue": { "type": "integer", "description": "Value of the installments." }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "referenceValue": { "type": "integer", "description": "Reference value used to calculate total order value with interest." }, "hasDefaultBillingAddress": { "type": "boolean", "description": "Indicates whether billing address for this payment is the default address." } } } }, "giftCards": { "type": "array", "description": "Gift card information, if it applies to the order.", "items": { "type": "string", "description": "Gift card." } }, "giftCardMessages": { "type": "array", "description": "Array of gift card messages.", "items": { "type": "string", "description": "Gift card message." } }, "availableAccounts": { "type": "array", "description": "Available accounts.", "items": { "type": "object", "description": "Available account.", "properties": { "accountId": { "type": "string", "description": "Account identifier." }, "paymentSystem": { "type": "string", "description": "Payment system identifier." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "cardNumber": { "type": "string", "description": "Masked card number." }, "bin": { "type": "string", "description": "Bank identification number." }, "availableAddresses": { "type": "array", "description": "Available addresses for this account.", "items": { "type": "string", "description": "Address identifier." } }, "expirationDate": { "type": "string", "description": "Card expiration date." }, "isExpired": { "type": "boolean", "description": "Indicates if the card is expired." }, "accountStatus": { "type": "string", "nullable": true, "description": "Account status." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization." }, "isCardToken": { "type": "boolean", "description": "Indicates if this is a card token." }, "cardLabel": { "type": "string", "description": "Card label." }, "cardOrigin": { "type": "string", "description": "Card origin." } } } }, "availableTokens": { "type": "array", "description": "Available tokens.", "items": { "type": "string", "description": "Available token." } }, "availableAssociations": { "type": "object", "description": "Available associations.", "properties": { "id": { "type": "string", "description": "Identifier for the association." } } } } }, "marketingData": { "type": "object", "nullable": true, "description": "Marketing data." }, "sellers": { "type": "array", "description": "Information on each seller.", "items": { "description": "Seller information.", "type": "object", "properties": { "id": { "type": "string", "description": "Seller ID." }, "name": { "type": "string", "description": "Seller name." }, "logo": { "type": "string", "description": "Seller logo.", "nullable": true } } } }, "clientPreferencesData": { "type": "object", "description": "Client preferences data.", "properties": { "locale": { "type": "string", "description": "Locale." }, "optinNewsLetter": { "type": "boolean", "description": "Indicates whether the user opted in to receive the store's newsletter (`true`) or not (`false`)." }, "savePersonalData": { "type": "boolean", "description": "Indicates if personal data should be saved." }, "savePaymentData": { "type": "boolean", "description": "Indicates if payment data should be saved." } } }, "commercialConditionData": { "type": "object", "description": "Object containing commercial condition information.", "nullable": true }, "storePreferencesData": { "type": "object", "description": "Store preferences data.", "properties": { "countryCode": { "type": "string", "description": "Country code." }, "saveUserData": { "type": "boolean", "description": "Indicates if user data should be saved." }, "timeZone": { "type": "string", "description": "Time zone." }, "currencyCode": { "type": "string", "description": "Currency code." }, "currencyLocale": { "type": "number", "description": "Currency locale." }, "currencySymbol": { "type": "string", "description": "Currency symbol." }, "currencyFormatInfo": { "type": "object", "description": "Currency format information.", "properties": { "currencyDecimalDigits": { "type": "number", "description": "Currency decimal digits." }, "currencyDecimalSeparator": { "type": "string", "description": "Currency decimal separator." }, "currencyGroupSeparator": { "type": "string", "description": "Currency group separator." }, "currencyGroupSize": { "type": "number", "description": "Currency group size." }, "startsWithCurrencySymbol": { "type": "boolean", "description": "Indicates if starts with currency symbol." } } } } }, "giftRegistryData": { "type": "object", "description": "Gift registry list information.", "nullable": true }, "openTextField": { "type": "string", "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).", "nullable": true }, "invoiceData": { "type": "object", "description": "Invoice data including billing address.", "nullable": true, "properties": { "address": { "type": "object", "description": "Billing address.", "properties": { "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State name." }, "country": { "type": "string", "description": "Country." }, "street": { "type": "string", "description": "Street name." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "description": "Address complement." }, "reference": { "type": "string", "description": "Reference for location." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates (latitude, longitude).", "items": { "type": "number", "description": "Coordinate value." } } } } } }, "customData": { "type": "object", "description": "Customer additional information.", "nullable": true }, "itemMetadata": { "type": "object", "description": "Item metadata.", "nullable": true, "properties": { "items": { "type": "array", "description": "List of objects containing metadata on each item in the order.", "items": { "description": "Item metadata.", "nullable": true, "type": "object", "properties": { "id": { "type": "string", "description": "Item ID." }, "seller": { "type": "string", "description": "Seller." }, "name": { "type": "string", "description": "Product name." }, "skuName": { "type": "string", "description": "SKU name." }, "productId": { "type": "string", "description": "Product ID." }, "refId": { "type": "string", "description": "Ref ID." }, "ean": { "type": "string", "description": "European Article Number.", "nullable": true }, "imageUrl": { "type": "string", "description": "Image URL." }, "detailUrl": { "type": "string", "description": "Detail URL." } } } } } }, "hooksData": { "type": "object", "description": "Hooks information.", "nullable": true }, "ratesAndBenefitsData": { "type": "object", "description": "Information on rates and benefits that apply to the order.", "properties": { "rateAndBenefitsIdentifiers": { "type": "array", "description": "List with rates and benefits identifiers.", "items": { "type": "string", "description": "Benefit identifier." } }, "teaser": { "type": "array", "description": "List with rates and benefits teasers.", "items": { "type": "string", "description": "Benefit teaser." } } } }, "subscriptionData": { "type": "object", "description": "Subscription information.", "nullable": true }, "merchantContextData": { "type": "object", "nullable": true, "description": "Merchant context data." }, "purchaseAgentsData": { "type": "object", "nullable": true, "description": "Purchase agents data." }, "itemsOrdination": { "type": "object", "description": "Object containing information about the ordering of items within the orderForm.", "nullable": true, "properties": { "criteria": { "type": "string", "description": "Criteria adopted to order the items in the list." }, "ascending": { "type": "boolean", "description": "Indicates whether the ordering is ascending." } } } } }, "example": { "orderFormId": "B0935AF4429441ABB4161111ED9D1104", "salesChannel": "1", "loggedIn": true, "isCheckedIn": false, "storeId": null, "checkedInPickupPointId": null, "allowManualPrice": false, "canEditData": true, "userProfileId": "46a42745-664f-48d2-ae33-76cd1dec5bde", "userType": null, "ignoreProfileData": false, "value": 0, "messages": [], "items": [], "selectableGifts": [], "totalizers": [], "shippingData": { "address": { "addressType": "residential", "receiverName": "Crystal Strosin I", "addressId": "0", "isDisposable": false, "editable": true, "postalCode": "96935744", "city": "Randallport", "state": "TI", "country": "BRA", "street": "1632 Elisa Common", "number": "3", "neighborhood": "Edmond Rempel", "complement": null, "reference": null, "geoCoordinates": [] }, "logisticsInfo": [], "selectedAddresses": [ { "addressType": "residential", "receiverName": "Crystal Strosin I", "addressId": "0", "isDisposable": false, "editable": true, "postalCode": "96935744", "city": "Randallport", "state": "TI", "country": "BRA", "street": "1632 Elisa Common", "number": "3", "neighborhood": "Edmond Rempel", "complement": null, "reference": null, "geoCoordinates": [] } ], "availableAddresses": [ { "addressType": "residential", "receiverName": "Crystal Strosin I", "addressId": "0", "isDisposable": false, "editable": true, "postalCode": "96935744", "city": "Randallport", "state": "TI", "country": "BRA", "street": "1632 Elisa Common", "number": "3", "neighborhood": "Edmond Rempel", "complement": null, "reference": null, "geoCoordinates": [] } ], "pickupPoints": [], "contactInformation": [] }, "clientProfileData": { "email": "fonihi3245@daxiake.com", "firstName": "Kristian", "lastName": "Kuhlman", "document": "01234567890", "documentType": "cpf", "phone": "+556589796821", "corporateName": null, "tradeName": null, "corporateDocument": null, "stateInscription": null, "corporatePhone": null, "isCorporate": false, "profileCompleteOnLoading": true, "profileErrorOnLoading": false, "customerClass": null }, "paymentData": { "updateStatus": "updated", "installmentOptions": [], "paymentSystems": [], "payments": [ { "paymentSystem": 6, "bin": null, "accountId": "12", "tokenId": null, "value": 34390, "referenceValue": 34390, "giftCardRedemptionCode": null, "giftCardProvider": null, "giftCardId": null } ], "giftCards": [], "giftCardMessages": [], "availableAccounts": [ { "accountId": "4A660C0DEA2D477C996D88C6D3FFB7C0", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "22343544", "availableAddresses": [ "12345" ], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": false, "isCardToken": true }, { "accountId": "7E49E29225E643C6817FC80AA5FA6EC1", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "223433", "availableAddresses": [], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": true, "cardLabel": "label teste shopper", "isCardToken": false, "cardOrigin": "shopper" } ], "availableTokens": [], "availableAssociations": {} }, "marketingData": null, "sellers": [], "clientPreferencesData": { "locale": "pt-BR", "optinNewsLetter": false, "savePersonalData": false, "savePaymentData": false }, "commercialConditionData": null, "storePreferencesData": { "countryCode": "BRA", "saveUserData": true, "timeZone": "E. South America Standard Time", "currencyCode": "BRL", "currencyLocale": 1046, "currencySymbol": "R$", "currencyFormatInfo": { "currencyDecimalDigits": 2, "currencyDecimalSeparator": ",", "currencyGroupSeparator": ".", "currencyGroupSize": 3, "startsWithCurrencySymbol": true } }, "giftRegistryData": null, "openTextField": null, "invoiceData": null, "customData": null, "itemMetadata": null, "hooksData": null, "ratesAndBenefitsData": { "rateAndBenefitsIdentifiers": [], "teaser": [] }, "subscriptionData": null, "merchantContextData": null, "purchaseAgentsData": null, "itemsOrdination": null } } } } } } }, "/api/checkout/pub/orderForm/{orderFormId}/transaction": { "post": { "tags": ["Checkout operations"], "summary": "Place order", "description": "Processes the order and creates a transaction.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "orderFormId", "in": "path", "description": "Unique identifier of the orderForm.", "required": true, "schema": { "type": "string", "example": "B0935AF4429441ABB4161111ED9D1104" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "referenceValue" ], "properties": { "savePersonalData": { "type": "boolean", "description": "Indicates if personal data should be saved." }, "optinNewsLetter": { "type": "boolean", "description": "Indicates if user opted in for newsletter." }, "value": { "type": "integer", "description": "Total value in cents." }, "referenceValue": { "type": "integer", "description": "Reference value in cents." }, "interestValue": { "type": "integer", "description": "Interest value in cents." } } }, "example": { "savePersonalData": true, "optinNewsLetter": true, "value": 20100, "referenceValue": 20100, "interestValue": 0 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the cart.", "nullable": true }, "merchantTransactions": { "type": "array", "description": "Information on each merchant transaction.", "items": { "description": "Merchant transaction information.", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the seller." }, "transactionId": { "type": "string", "description": "ID of the transaction in the platform." }, "merchantName": { "type": "string", "description": "Name of the merchant responsible for the sale." }, "payments": { "type": "array", "description": "Information on each payment pertinent to the transaction.", "items": { "description": "Payment information.", "type": "object", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system." }, "bin": { "type": "string", "description": "Payment bin.", "nullable": true }, "accountId": { "type": "string", "description": "Account ID.", "nullable": true }, "tokenId": { "type": "string", "description": "Token ID.", "nullable": true }, "value": { "type": "integer", "description": "Total value to be paid in this payment." }, "referenceValue": { "type": "integer", "description": "Reference value over which interests may be applied." }, "giftCardRedemptionCode": { "type": "string", "description": "Gift card redemption code.", "nullable": true }, "giftCardProvider": { "type": "string", "description": "Gift card provider.", "nullable": true }, "giftCardId": { "type": "string", "description": "Gift card ID.", "nullable": true } } } } } } }, "receiverUri": { "type": "string", "description": "Receiver URI.", "nullable": true }, "gatewayCallbackTemplatePath": { "type": "string", "description": "Gateway callback template path.", "nullable": true }, "orderGroup": { "type": "string", "description": "Order group.", "nullable": true }, "orderFormId": { "type": "string", "description": "Unique identifier of the orderForm." }, "salesChannel": { "type": "string", "description": "Sales channel identifier." }, "loggedIn": { "type": "boolean", "description": "Indicates if the user is logged in." }, "isCheckedIn": { "type": "boolean", "description": "Indicates if the user is checked in." }, "storeId": { "type": "string", "nullable": true, "description": "Store identifier." }, "checkedInPickupPointId": { "type": "string", "nullable": true, "description": "Checked-in pickup point identifier." }, "allowManualPrice": { "type": "boolean", "description": "Indicates if manual price is allowed." }, "canEditData": { "type": "boolean", "description": "Indicates if data can be edited." }, "userProfileId": { "type": "string", "description": "User profile identifier.", "nullable": true }, "userType": { "type": "string", "nullable": true, "description": "User type." }, "ignoreProfileData": { "type": "boolean", "description": "Indicates if profile data should be ignored." }, "value": { "type": "number", "description": "Total value of the order." }, "messages": { "type": "array", "description": "List of messages.", "items": { "type": "object", "description": "Message information.", "properties": { "message": { "type": "string", "description": "Message." } } } }, "items": { "type": "array", "description": "List of items in the order.", "items": { "type": "object", "description": "Item information.", "properties": { "id": { "type": "string", "description": "Identifier for the item." } } } }, "selectableGifts": { "type": "array", "description": "List of selectable gifts.", "items": { "type": "object", "description": "Selectable gift information.", "properties": { "id": { "type": "string", "description": "Identifier for the selectable gift." } } } }, "totalizers": { "type": "array", "description": "List of totalizers.", "items": { "type": "object", "description": "Totalizer information.", "properties": { "id": { "type": "string", "description": "Identifier for the totalizer." }, "name": { "type": "string", "description": "Name for the totalizer." } } } }, "shippingData": { "type": "object", "description": "Shipping data.", "properties": { "address": { "type": "object", "description": "Address information.", "nullable": true, "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } }, "logisticsInfo": { "type": "array", "description": "List of logistics information.", "items": { "type": "object", "description": "Logistics information.", "properties": { "id": { "type": "string", "description": "Identifier for the logistics information." } } } }, "selectedAddresses": { "type": "array", "description": "List of selected addresses.", "items": { "type": "object", "description": "Selected address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Coordinate value." } } } } }, "availableAddresses": { "type": "array", "description": "List of available addresses.", "items": { "type": "object", "description": "Available address details.", "properties": { "addressType": { "type": "string", "description": "Address type." }, "receiverName": { "type": "string", "description": "Receiver name." }, "addressId": { "type": "string", "description": "Address identifier." }, "isDisposable": { "type": "boolean", "description": "Indicates if the address is disposable." }, "editable": { "type": "boolean", "description": "Indicates if the address is editable." }, "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State." }, "country": { "type": "string", "description": "Country code." }, "street": { "type": "string", "description": "Street." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "nullable": true, "description": "Address complement." }, "reference": { "type": "string", "nullable": true, "description": "Address reference." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates.", "items": { "type": "number", "description": "Geographic coordinate." } } } } }, "pickupPoints": { "type": "array", "description": "List of pickup points.", "items": { "type": "object", "description": "Pickup point information.", "properties": { "id": { "type": "string", "description": "Identifier for the pickup point." } } } }, "contactInformation": { "type": "array", "description": "List of contact information.", "items": { "type": "object", "description": "Contact information.", "properties": { "id": { "type": "string", "description": "Identifier for the contact information." } } } } } }, "clientProfileData": { "type": "object", "description": "Client profile data.", "nullable": true, "properties": { "email": { "type": "string", "description": "Email address." }, "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "document": { "type": "string", "description": "Document number." }, "documentType": { "type": "string", "description": "Document type." }, "phone": { "type": "string", "description": "Phone number." }, "corporateName": { "type": "string", "nullable": true, "description": "Corporate name." }, "tradeName": { "type": "string", "nullable": true, "description": "Trade name." }, "corporateDocument": { "type": "string", "nullable": true, "description": "Corporate document." }, "stateInscription": { "type": "string", "nullable": true, "description": "State inscription." }, "corporatePhone": { "type": "string", "nullable": true, "description": "Corporate phone." }, "isCorporate": { "type": "boolean", "description": "Indicates if the profile is corporate." }, "profileCompleteOnLoading": { "type": "boolean", "description": "Indicates if the profile is complete on loading." }, "profileErrorOnLoading": { "type": "boolean", "description": "Indicates if there was an error loading the profile." }, "customerClass": { "type": "string", "nullable": true, "description": "Customer class." } } }, "paymentData": { "type": "object", "description": "Payment data.", "properties": { "updateStatus": { "type": "string", "description": "Update status." }, "installmentOptions": { "type": "array", "description": "List of Installment options.", "items": { "type": "object", "description": "Information about the installment option.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system identification." }, "bin": { "type": "string", "description": "Card bin.", "nullable": true }, "paymentName": { "type": "string", "description": "Payment name.", "nullable": true }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "nullable": true }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "installments": { "type": "array", "description": "Installment information.", "items": { "type": "object", "description": "Installment information.", "properties": { "count": { "type": "integer", "description": "Count information." }, "hasInterestRate": { "type": "boolean", "description": "Indicates whether the payment has interest." }, "interestRate": { "type": "integer", "description": "Interest rate value." }, "value": { "type": "integer", "description": "Value of the order without the interest rate. The value is shown without separating cents." }, "total": { "type": "integer", "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`." }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments information.", "items": { "type": "object", "description": "Installment information." } } } } } } } }, "paymentSystems": { "type": "array", "description": "Information on payment systems.", "items": { "type": "object", "description": "Payment system information.", "properties": { "id": { "type": "integer", "description": "Payment system ID." }, "name": { "type": "string", "description": "Payment system name." }, "groupName": { "type": "string", "description": "Payment group name." }, "validator": { "type": "object", "description": "Payment system validator.", "nullable": true }, "stringId": { "type": "string", "description": "String ID." }, "template": { "type": "string", "description": "Template." }, "requiresDocument": { "type": "boolean", "description": "Indicates whether a document is required." }, "displayDocument": { "type": "boolean", "description": "Indicates whether a document is shown." }, "isCustom": { "type": "boolean", "description": "Indicates whether it is custom." }, "description": { "type": "string", "description": "Description.", "nullable": true }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether a authentication is required." }, "dueDate": { "type": "string", "description": "Payment due date." }, "availablePayments": { "type": "string", "description": "Availability of payment.", "nullable": true } } } }, "payments": { "type": "array", "description": "Array with information on each payment chosen by the shopper.", "items": { "type": "object", "description": "Payment information.", "properties": { "paymentSystem": { "type": "integer", "description": "Payment system ID." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "group": { "type": "string", "description": "Payment system group." }, "installments": { "type": "integer", "description": "Selected number of installments." }, "installmentsInterestRate": { "type": "number", "description": "Installments' interest rate." }, "installmentsValue": { "type": "integer", "description": "Value of the installments." }, "value": { "type": "integer", "description": "Total value assigned to this payment." }, "referenceValue": { "type": "integer", "description": "Reference value used to calculate total order value with interest." }, "hasDefaultBillingAddress": { "type": "boolean", "description": "Indicates whether billing address for this payment is the default address." } } } }, "giftCards": { "type": "array", "description": "Gift card information, if it applies to the order.", "items": { "type": "string", "description": "Gift card." } }, "giftCardMessages": { "type": "array", "description": "Array of gift card messages.", "items": { "type": "string", "description": "Gift card message." } }, "availableAccounts": { "type": "array", "description": "Available accounts.", "items": { "type": "object", "description": "Available account.", "properties": { "accountId": { "type": "string", "description": "Account identifier." }, "paymentSystem": { "type": "string", "description": "Payment system identifier." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "cardNumber": { "type": "string", "description": "Masked card number." }, "bin": { "type": "string", "description": "Bank identification number." }, "availableAddresses": { "type": "array", "description": "Available addresses for this account.", "items": { "type": "string", "description": "Address identifier." } }, "expirationDate": { "type": "string", "description": "Card expiration date." }, "isExpired": { "type": "boolean", "description": "Indicates if the card is expired." }, "accountStatus": { "type": "string", "nullable": true, "description": "Account status." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization." }, "isCardToken": { "type": "boolean", "description": "Indicates if this is a card token." }, "cardLabel": { "type": "string", "description": "Card label." }, "cardOrigin": { "type": "string", "description": "Card origin." } } } }, "availableTokens": { "type": "array", "description": "Available tokens.", "items": { "type": "string", "description": "Available token." } }, "availableAssociations": { "type": "object", "description": "Available associations.", "properties": { "id": { "type": "string", "description": "Identifier for the association." } } } } }, "marketingData": { "type": "object", "nullable": true, "description": "Marketing data." }, "sellers": { "type": "array", "description": "Information on each seller.", "items": { "description": "Seller information.", "type": "object", "properties": { "id": { "type": "string", "description": "Seller ID." }, "name": { "type": "string", "description": "Seller name." }, "logo": { "type": "string", "description": "Seller logo.", "nullable": true } } } }, "clientPreferencesData": { "type": "object", "description": "Client preferences data.", "properties": { "locale": { "type": "string", "description": "Locale." }, "optinNewsLetter": { "type": "boolean", "description": "Indicates whether the user opted in to receive the store's newsletter (`true`) or not (`false`)." }, "savePersonalData": { "type": "boolean", "description": "Indicates if personal data should be saved." }, "savePaymentData": { "type": "boolean", "description": "Indicates if payment data should be saved." } } }, "commercialConditionData": { "type": "object", "description": "Object containing commercial condition information.", "nullable": true }, "storePreferencesData": { "type": "object", "description": "Store preferences data.", "properties": { "countryCode": { "type": "string", "description": "Country code." }, "saveUserData": { "type": "boolean", "description": "Indicates if user data should be saved." }, "timeZone": { "type": "string", "description": "Time zone." }, "currencyCode": { "type": "string", "description": "Currency code." }, "currencyLocale": { "type": "number", "description": "Currency locale." }, "currencySymbol": { "type": "string", "description": "Currency symbol." }, "currencyFormatInfo": { "type": "object", "description": "Currency format information.", "properties": { "currencyDecimalDigits": { "type": "number", "description": "Currency decimal digits." }, "currencyDecimalSeparator": { "type": "string", "description": "Currency decimal separator." }, "currencyGroupSeparator": { "type": "string", "description": "Currency group separator." }, "currencyGroupSize": { "type": "number", "description": "Currency group size." }, "startsWithCurrencySymbol": { "type": "boolean", "description": "Indicates if starts with currency symbol." } } } } }, "giftRegistryData": { "type": "object", "description": "Gift registry list information.", "nullable": true }, "openTextField": { "type": "string", "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).", "nullable": true }, "invoiceData": { "type": "object", "description": "Invoice data including billing address.", "nullable": true, "properties": { "address": { "type": "object", "description": "Billing address.", "properties": { "postalCode": { "type": "string", "description": "Postal code." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State name." }, "country": { "type": "string", "description": "Country." }, "street": { "type": "string", "description": "Street name." }, "number": { "type": "string", "description": "Street number." }, "neighborhood": { "type": "string", "description": "Neighborhood." }, "complement": { "type": "string", "description": "Address complement." }, "reference": { "type": "string", "description": "Reference for location." }, "geoCoordinates": { "type": "array", "description": "Geographic coordinates (latitude, longitude).", "items": { "type": "number", "description": "Coordinate value." } } } } } }, "customData": { "type": "object", "description": "Customer additional information.", "nullable": true }, "itemMetadata": { "type": "object", "description": "Item metadata.", "nullable": true, "properties": { "items": { "type": "array", "description": "List of objects containing metadata on each item in the order.", "items": { "description": "Item metadata.", "nullable": true, "type": "object", "properties": { "id": { "type": "string", "description": "Item ID." }, "seller": { "type": "string", "description": "Seller." }, "name": { "type": "string", "description": "Product name." }, "skuName": { "type": "string", "description": "SKU name." }, "productId": { "type": "string", "description": "Product ID." }, "refId": { "type": "string", "description": "Ref ID." }, "ean": { "type": "string", "description": "European Article Number.", "nullable": true }, "imageUrl": { "type": "string", "description": "Image URL." }, "detailUrl": { "type": "string", "description": "Detail URL." } } } } } }, "hooksData": { "type": "object", "description": "Hooks information.", "nullable": true }, "ratesAndBenefitsData": { "type": "object", "description": "Information on rates and benefits that apply to the order.", "properties": { "rateAndBenefitsIdentifiers": { "type": "array", "description": "List with rates and benefits identifiers.", "items": { "type": "string", "description": "Benefit identifier." } }, "teaser": { "type": "array", "description": "List with rates and benefits teasers.", "items": { "type": "string", "description": "Benefit teaser." } } } }, "subscriptionData": { "type": "object", "description": "Subscription information.", "nullable": true }, "merchantContextData": { "type": "object", "nullable": true, "description": "Merchant context data." }, "purchaseAgentsData": { "type": "object", "nullable": true, "description": "Purchase agents data." }, "itemsOrdination": { "type": "object", "description": "Object containing information about the ordering of items within the orderForm.", "nullable": true, "properties": { "criteria": { "type": "string", "description": "Criteria adopted to order the items in the list." }, "ascending": { "type": "boolean", "description": "Indicates whether the ordering is ascending." } } } } }, "example": { "id": null, "merchantTransactions": [], "receiverUri": null, "gatewayCallbackTemplatePath": null, "orderGroup": null, "orderFormId": "90E824E30F1440FB8B578C04605C001B", "salesChannel": "1", "loggedIn": true, "isCheckedIn": false, "storeId": null, "checkedInPickupPointId": null, "allowManualPrice": false, "canEditData": true, "userProfileId": null, "userType": null, "ignoreProfileData": false, "value": 20000, "messages": [ { "code": "CHK0210", "text": "Valor do pagamento não confere com o valor esperado", "status": "warning", "fields": {} } ], "items": [ { "uniqueId": "FFF85FD3EC8A4D2C86CB32E14E1AB89F", "id": "1", "productId": "1", "productRefId": "ref123456", "refId": "ref123456", "ean": null, "name": "Produto Teste SKU Teste", "skuName": "SKU Teste", "modalType": "", "parentItemIndex": null, "parentAssemblyBinding": null, "assemblies": [], "priceValidUntil": "2027-01-23T18:14:38Z", "tax": 0, "price": 2000, "listPrice": 2000, "manualPrice": null, "manualPriceAppliedBy": null, "sellingPrice": 2000, "rewardValue": 0, "isGift": false, "additionalInfo": { "dimension": null, "brandName": "Brand name", "brandId": "2000000", "offeringInfo": null, "offeringType": null, "offeringTypeId": null }, "preSaleDate": null, "productCategoryIds": "/1/", "productCategories": { "1": "Category" }, "quantity": 10, "seller": "1", "sellerChain": [ "1" ], "imageUrl": "https://gatewayqabrmkt.vteximg.com.br/arquivos/ids/155394-55-55/imagem produto.jpg.jpg?v=638826675586530000", "detailUrl": "/produto-teste/p", "components": [], "bundleItems": [], "attachments": [], "attachmentOfferings": [], "offerings": [], "priceTags": [], "availability": "available", "measurementUnit": "un", "unitMultiplier": 1.0, "manufacturerCode": null, "priceDefinition": { "calculatedSellingPrice": 2000, "total": 20000, "sellingPrices": [ { "value": 2000, "quantity": 10 } ], "reason": null }, "taxCode": "" } ], "selectableGifts": [], "totalizers": [ { "id": "Items", "name": "Total dos Itens", "value": 20000 } ], "shippingData": { "address": null, "logisticsInfo": [ { "itemIndex": 0, "selectedSla": null, "selectedDeliveryChannel": "delivery", "addressId": null, "slas": [], "shipsTo": [ "BRA", "USA" ], "itemId": "1", "deliveryChannels": [ { "id": "delivery" } ] } ], "selectedAddresses": [], "availableAddresses": [], "pickupPoints": [], "contactInformation": [] }, "clientProfileData": null, "paymentData": { "updateStatus": "updated", "installmentOptions": [ { "paymentSystem": 1, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": 2, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000 } ] }, { "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000 } ] }, { "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000 } ] }, { "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000 } ] }, { "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000 } ] }, { "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000 } ] }, { "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000 } ] }, { "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000 } ] }, { "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000 } ] } ] }, { "paymentSystem": 3, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 10000, "total": 20000 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 6666, "total": 20000 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 5000, "total": 20000 } ] }, { "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 5, "hasInterestRate": false, "interestRate": 0, "value": 4000, "total": 20000 } ] }, { "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 6, "hasInterestRate": false, "interestRate": 0, "value": 3333, "total": 20000 } ] }, { "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 7, "hasInterestRate": false, "interestRate": 0, "value": 2857, "total": 20000 } ] }, { "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 8, "hasInterestRate": false, "interestRate": 0, "value": 2500, "total": 20000 } ] }, { "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 9, "hasInterestRate": false, "interestRate": 0, "value": 2222, "total": 20000 } ] }, { "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 10, "hasInterestRate": false, "interestRate": 0, "value": 2000, "total": 20000 } ] }, { "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 11, "hasInterestRate": false, "interestRate": 0, "value": 1818, "total": 20000 } ] }, { "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 12, "hasInterestRate": false, "interestRate": 0, "value": 1666, "total": 20000 } ] } ] }, { "paymentSystem": 16, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": 17, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": 201, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] }, { "paymentSystem": 900, "bin": null, "paymentName": null, "paymentGroupName": null, "value": 20000, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000, "sellerMerchantInstallments": [ { "id": "GATEWAYQABRMKT", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 20000, "total": 20000 } ] } ] } ], "paymentSystems": [ { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^4[0-9]{15}$", "mask": "9999 9999 9999 9999", "cardCodeRegex": "^[0-9]{3}$", "cardCodeMask": "999", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": "null", "requiresAuthentication": false, "dueDate": "2026-01-30T18:13:38.9668706Z", "availablePayments": null }, { "id": 201, "name": "Promissory", "groupName": "custom201PaymentGroupPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "201", "template": "custom201PaymentGroupPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": true, "description": "Promissory Description", "requiresAuthentication": false, "dueDate": "2026-01-30T18:14:38.9668708Z", "availablePayments": null }, { "id": 3, "name": "Diners", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^3(0[0-5]|[68][0-9])[0-9]{11}$", "mask": "9999 999999 9999", "cardCodeRegex": "^[0-9]{3}$", "cardCodeMask": "999", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "3", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2026-01-30T18:13:38.9668711Z", "availablePayments": null }, { "id": 16, "name": "Vale", "groupName": "giftCardPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "16", "template": "giftCardPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2026-01-30T18:13:38.9668712Z", "availablePayments": null }, { "id": 1, "name": "American Express", "groupName": "creditCardPaymentGroup", "validator": { "regex": "^3[47][0-9]{13}$", "mask": "9999 999999 99999", "cardCodeRegex": "^[0-9]{4}$", "cardCodeMask": "9999", "weights": [ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true }, "stringId": "1", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "displayDocument": true, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2026-01-30T18:13:38.9668714Z", "availablePayments": null }, { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2026-01-30T18:14:38.9668716Z", "availablePayments": null }, { "id": 900, "name": "WH Google Pay", "groupName": "WH Google PayPaymentGroup", "validator": { "regex": null, "mask": null, "cardCodeRegex": null, "cardCodeMask": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false }, "stringId": "900", "template": "WH Google PayPaymentGroup-template", "requiresDocument": false, "displayDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2026-01-30T18:13:38.9668717Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [ { "accountId": "4A660C0DEA2D477C996D88C6D3FFB7C0", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "22343544", "availableAddresses": [ "12345" ], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": false, "isCardToken": true }, { "accountId": "7E49E29225E643C6817FC80AA5FA6EC1", "paymentSystem": "2", "paymentSystemName": "Visa", "cardNumber": "************5454", "bin": "223433", "availableAddresses": [], "expirationDate": "02/2029", "isExpired": false, "accountStatus": null, "useCvvForAuthorization": true, "cardLabel": "label teste shopper", "isCardToken": false, "cardOrigin": "shopper" } ], "availableTokens": [], "availableAssociations": {} }, "marketingData": null, "sellers": [ { "id": "1", "name": "Gateway Payments", "logo": "", "minimumOrderValue": 5000 } ], "clientPreferencesData": { "locale": "pt-BR", "optinNewsLetter": false, "savePersonalData": false, "savePaymentData": false }, "commercialConditionData": null, "storePreferencesData": { "countryCode": "BRA", "saveUserData": true, "timeZone": "E. South America Standard Time", "currencyCode": "BRL", "currencyLocale": 1046, "currencySymbol": "R$", "currencyFormatInfo": { "currencyDecimalDigits": 2, "currencyDecimalSeparator": ",", "currencyGroupSeparator": ".", "currencyGroupSize": 3, "startsWithCurrencySymbol": true } }, "giftRegistryData": null, "openTextField": null, "invoiceData": null, "customData": null, "itemMetadata": { "items": [ { "id": "1", "seller": "1", "name": "Produto Teste SKU Teste", "skuName": "SKU Teste", "productId": "1", "refId": "ref123456", "ean": null, "imageUrl": "https://gatewayqabrmkt.vteximg.com.br/arquivos/ids/155394-55-55/imagem produto.jpg.jpg?v=638826675586530000", "detailUrl": "/produto-teste/p", "assemblyOptions": [] } ] }, "hooksData": null, "ratesAndBenefitsData": { "rateAndBenefitsIdentifiers": [], "teaser": [] }, "subscriptionData": null, "merchantContextData": null, "purchaseAgentsData": null, "itemsOrdination": null } } } } } } }, "/api/pvt/transactions/{transactionId}": { "get": { "tags": ["Payment gateway"], "summary": "Get transaction details", "description": "Retrieves detailed information about a specific transaction.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "transactionId", "in": "path", "description": "Unique identifier of the transaction.", "required": true, "schema": { "type": "string", "example": "1234567890ABC" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Transaction status.", "enum": [ "Approved" ] }, "transactionId": { "type": "string", "description": "Transaction ID." } } }, "example": { "status": "Approved", "transactionId": "1234567890ABC" } } } } } } }, "/api/pvt/transactions/{transactionId}/payments": { "get": { "tags": ["Payment gateway"], "summary": "List payments", "description": "Retrieves a list of payments associated with a transaction.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "transactionId", "in": "path", "description": "Unique identifier of the transaction.", "required": true, "schema": { "type": "string", "example": "1234567890ABC" } }, { "name": "an", "in": "query", "description": "Account name parameter.", "required": true, "schema": { "type": "string", "example": "apiexamples" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of payments.", "items": { "type": "object", "description": "Payment object with fields.", "properties": { "id": { "type": "string", "description": "Payment ID." }, "fields": { "type": "array", "description": "Payment fields.", "items": { "type": "object", "description": "Payment field name and value.", "properties": { "name": { "type": "string", "description": "Field name." }, "value": { "type": "string", "description": "Field value." } } } } } } }, "example": [ { "id": "payment-id-123", "fields": [ { "name": "accountId", "value": "4A660C0DEA2D477C996D88C6D3FFB7C0" } ] } ] } } } } } }, "/api/pvt/accounts/{accountId}": { "get": { "tags": ["Payment gateway"], "summary": "Get card", "description": "Retrieves card information by account ID.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "accountId", "in": "path", "description": "Unique identifier of the account.", "required": true, "schema": { "type": "string", "example": "4A660C0DEA2D477C996D88C6D3FFB7C0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bin": { "type": "string", "description": "BIN (Bank Identification Number)." }, "lastDigits": { "type": "string", "description": "Last four digits of the card." }, "expiryMonth": { "type": "string", "description": "Expiry month." }, "expiryYear": { "type": "string", "description": "Expiry year." }, "mask": { "type": "string", "description": "Masked card number." }, "paymentSystem": { "type": "integer", "description": "Payment system identifier." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "address": { "type": "string", "description": "JSON string containing address information. The JSON must include the following address information `addressType`, `addressId`, `postalCode`, `street`,`neighborhood`, `city`, `state`,`country`, `number`, `complement`." }, "document": { "type": "string", "nullable": true, "description": "Document associated with the card." }, "label": { "type": "string", "description": "Label or description for the tokenized card." }, "tokens": { "type": "array", "description": "List of tokens associated with the card.", "items": { "type": "object", "description": "Token details.", "properties": { "providerId": { "type": "string", "description": "Provider identifier." }, "type": { "type": "string", "description": "Token type." }, "value": { "type": "string", "description": "Token value." }, "expiration": { "type": "string", "description": "Token expiration date." }, "href": { "type": "string", "nullable": true, "description": "Token URL reference." }, "providerCardTokentId": { "type": "string", "description": "Provider card token identifier." }, "useCvvForAuthorization": { "type": "boolean", "description": "Indicates if CVV is required for authorization." }, "extraData": { "type": "object", "nullable": true, "description": "Additional data." } } } } } }, "example": { "bin": "123231", "lastDigits": "1231", "expiryMonth": "05", "expiryYear": "2031", "mask": "1231 1231 1231 1231", "paymentSystem": 2, "paymentSystemName": "Visa", "address": "{\"addressType\":\"billing\",\"addressId\":null,\"postalCode\":\"73065772\",\"street\":\"17395 Gutmann Expressway\",\"neighborhood\":\"John Doe\",\"city\":\"Dublin\",\"state\":\"FO\",\"country\":\"Guadeloupe\",\"number\":\"4\",\"complement\":null}", "document": null, "label": "01.A. Save 1 tokenized credit card via api using an external credential", "tokens": [ { "providerId": "123579", "type": "TOKEN_VALUE", "value": "1231123112311231", "expiration": "2031-05", "href": null, "providerCardTokentId": "A9FC15D4B46241BCBBE13AA6C29DA721", "useCvvForAuthorization": false, "extraData": null } ] } } } } } } }, "/api/profile-system/pvt/profiles/{profileId}/vcs-checkout": { "get": { "tags": ["Profile management"], "summary": "Get profile cards", "description": "Retrieves the list of cards associated with a profile.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "profileId", "in": "path", "description": "Unique identifier of the profile.", "required": true, "schema": { "type": "string", "example": "12345678-1234-1234-1234-123456789012" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentData": { "type": "string", "description": "JSON string containing payment data with available accounts." }, "orderFormIds": { "type": "string", "description": "JSON array string of orderForm IDs." }, "lastOrderTimestamp": { "type": "string", "description": "Timestamp of the last order." }, "lastUserPurchases": { "type": "string", "description": "JSON array string of last user purchases." } } }, "example": { "paymentData": "{\"availableAccounts\":[{\"accountId\":\"8BBB7A9E2F3E4DEAB95598768FCDAA03\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************7282\",\"bin\":\"719021\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"09/2034\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"05BCD6E708E34A86A2E3D229896745F8\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************7936\",\"bin\":\"955018\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"06/2030\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"366EF4DFD53E4596B398AC6EDAFD5E65\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************2086\",\"bin\":\"608068\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"10/2034\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"9ACDA83126904979BBFAC2C67B312B08\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************8069\",\"bin\":\"258468\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"04/2036\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"B52F9763048A43559B1CCBD4D25F101A\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************3771\",\"bin\":\"610801\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"02/2038\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"877875290BD643E7AEA2FED4B64119CC\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************9249\",\"bin\":\"416268\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"03/2040\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"ED805599F1F94C2A9499FC0B8D82309B\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************3772\",\"bin\":\"209248\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"07/2037\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"FDD60327908544D6AA57AAA6A09897A1\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************9652\",\"bin\":\"410210\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"02/2036\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"2A226422F78F4964A44C8A33E5CE4D22\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************4149\",\"bin\":\"792834\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"01/2036\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"294EDE2C2C8C4A6691CA3CF7B851BAE7\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************0718\",\"bin\":\"423993\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"11/2034\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"14A190E3C87A48E08617A8B19E5823AC\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************7250\",\"bin\":\"750390\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"03/2039\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"296851A59AB94C069B2C0018C954C35C\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************2631\",\"bin\":\"768842\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"09/2036\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null},{\"accountId\":\"3ED4BCE268C242BA8FDB67FC03DE16C5\",\"paymentSystem\":\"2\",\"paymentSystemName\":\"Visa\",\"cardNumber\":\"************9931\",\"bin\":\"169231\",\"availableAddresses\":[\"0\"],\"expirationDate\":\"05/2031\",\"isExpired\":false,\"accountStatus\":null,\"cardLabel\":null,\"useCvvForAuthorization\":false,\"isCardToken\":false,\"cardOrigin\":null}],\"availableTokens\":[],\"transactions\":null,\"giftCards\":[],\"giftCardMessages\":[],\"numberOfPaymentErrors\":0,\"numberOfDeniedTransactions\":0,\"lastDeniedTransaction\":null}", "orderFormIds": "[\"B0935AF4429441ABB4161111ED9D1104\",\"5CC694F876BA48AD9B321F77E93DD4CC\",\"426A2E06DADD4E40A97C72EA293DAC32\",\"2848EF90C7C144159DDCAD351863DAA5\",\"0079423F733F488693DB8B887A0366FF\",\"4A8CBEDF93B44AB3A0022C5F7D1BD1DD\"]", "lastOrderTimestamp": "2025-12-18T19:21:08.8187148+00:00", "lastUserPurchases": "[{\"creationDate\":\"2025-08-12T19:55:01.1486741Z\",\"orderId\":\"1553720500452-01\",\"orderGroup\":\"1553720500452\",\"value\":20100},{\"creationDate\":\"2025-12-16T19:45:26.8542459Z\",\"orderId\":\"1583960500454-01\",\"orderGroup\":\"1583960500454\",\"value\":20100},{\"creationDate\":\"2025-12-18T19:21:07.3907063Z\",\"orderId\":\"1584430500460-01\",\"orderGroup\":\"1584430500460\",\"value\":20100}]" } } } } } } }, "/api/profile-system/pvt/profiles/{profileId}/personalData": { "delete": { "tags": ["Profile management"], "summary": "Delete profile", "description": "Deletes personal data for a specific profile.\n\n>⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.\n\n>ℹ️ This endpoint must use the `accountAuthCookie` value generated from the [Validate client login](https://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api#post-/api/vtexid/pub/authentication/classic/validate) endpoint.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "profileId", "in": "path", "description": "Unique identifier of the profile.", "required": true, "schema": { "type": "string", "example": "12345678-1234-1234-1234-123456789012" } }, { "name": "an", "in": "query", "description": "Account name parameter.", "required": true, "schema": { "type": "string", "example": "apiexamples" } } ], "responses": { "204": { "description": "No Content" } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the API key." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the API key." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "User token, valid for 24 hours." } }, "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "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" } } } }, "tags": [ { "name": "Profile management" }, { "name": "Card token vault" }, { "name": "Checkout operations" }, { "name": "Authentication" }, { "name": "Payment gateway" } ] }