Vtex Addpaymentdata Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "AddPaymentData",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData",
"summary": "VTex Add payment data",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "29154e27383145cc8ce1f7a1df0d99c4",
"salesChannel": "1",
"loggedIn": false,
"isCheckedIn": false,
"storeId": "1",
"checkedInPickupPointId": "21",
"allowManualPrice": false,
"canEditData": true,
"userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
"userType": "User type",
"ignoreProfileData": false,
"value": 65780,
"messages": [],
"items": [
{
"uniqueId": "3CBFA140CE8F4E208062FC15CE9ED8D3",
"id": "2",
"productId": "2",
"productRefId": "1",
"refId": "CBC30L",
"ean": null,
"name": "Chopp Claro 30L",
"skuName": "Chopp Claro 30L",
"modalType": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"assemblies": [],
"priceValidUntil": "2022-07-28T22:25:25Z",
"tax": 0,
"price": 32890,
"listPrice": 49900,
"manualPrice": null,
"manualPriceAppliedBy": null,
"sellingPrice": 32890,
"rewardValue": 0,
"isGift": false,
"additionalInfo": {
"dimension": null,
"brandName": "Beershow",
"brandId": "2000000",
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"preSaleDate": null,
"productCategoryIds": "/1/",
"productCategories": {
"1": "Bebidas"
},
"quantity": 2,
"seller": "1",
"sellerChain": [
"1"
],
"imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
"detailUrl": "/chopp-claro-30l/p",
"components": [],
"bundleItems": [],
"attachments": [],
"attachmentOfferings": [],
"offerings": [],
"priceTags": [],
"availability": "available",
"measurementUnit": "un",
"unitMultiplier": 1,
"manufacturerCode": null,
"priceDefinition": {
"calculatedSellingPrice": 32890,
"total": 65780,
"sellingPrices": [
{
"value": 32890,
"quantity": 2
}
]
}
}
],
"selectableGifts": [],
"totalizers": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 65780
}
],
"shippingData": {
"address": null,
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"selectedDeliveryChannel": "delivery",
"addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
"slas": [],
"shipsTo": [
"BRA",
"COL",
"USA"
],
"itemId": "2",
"deliveryChannels": [
{
"id": "delivery"
},
{
"id": "pickup-in-point"
}
]
}
],
"selectedAddresses": [],
"availableAddresses": [],
"pickupPoints": []
},
"clientProfileData": null,
"paymentData": {
"updateStatus": "updated",
"installmentOptions": [
{
"paymentSystem": 2,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 65780,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780,
"sellerMerchantInstallments": [
{
"id": "MYSHOP",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780
}
]
}
]
},
{
"paymentSystem": 4,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 65780,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780,
"sellerMerchantInstallments": [
{
"id": "MYSHOP",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780
}
]
}
]
},
{
"paymentSystem": 6,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 65780,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780,
"sellerMerchantInstallments": [
{
"id": "MYSHOP",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 65780,
"total": 65780
}
]
}
]
}
],
"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,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2021-08-04T22:19:04.9948627Z",
"availablePayments": null
},
{
"id": 4,
"name": "Mastercard",
"groupName": "creditCardPaymentGroup",
"validator": {
"regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
"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": "4",
"template": "creditCardPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2021-08-04T22:19:04.9948627Z",
"availablePayments": null
},
{
"id": 6,
"name": "Boleto Banc\u00e1rio",
"groupName": "bankInvoicePaymentGroup",
"validator": {
"regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
"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": "6",
"template": "bankInvoicePaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2021-08-04T22:19:04.9948627Z",
"availablePayments": null
}
],
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"installments": 1,
"referenceValue": 65780,
"value": 65780,
"merchantSellerPayments": [
{
"id": "MYSHOP",
"installments": 1,
"referenceValue": 65780,
"value": 65780,
"interestRate": 0,
"installmentValue": 65780
}
]
}
],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
},
"marketingData": null,
"sellers": [
{
"id": "1",
"name": "My Seller",
"logo": "Logo"
}
],
"clientPreferencesData": {
"locale": "pt-BR",
"optinNewsLetter": null
},
"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": "2",
"seller": "1",
"name": "Chopp Claro 30L",
"skuName": "Chopp Claro 30L",
"productId": "2",
"refId": "CBC30L",
"ean": null,
"imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
"detailUrl": "/chopp-claro-30l/p",
"assemblyOptions": []
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}