Plataformas Digitais - Brazil
  1. Payment
Plataformas Digitais - Brazil
  • SPDBR Journey API
  • Service PDP
    • Get Product by Slug V2
      GET
    • Get Translate review
      GET
    • Get product review
      GET
    • Get Product by Slug
      GET
  • Service Search
    • Search
      • Search Products by Term
      • teste, preco na busca
    • Autocomplete
      • Get Autocomplete suggestions
    • Recommendation
      • Pages Recommendations V3
    • TopSearch
  • Service Member
    • Address
      • UpdateAddress
      • AddAddress
      • RemoveAddress
      • GetAddress
    • Consent
      • UpdateConsent
      • GetConsent
    • Store
      • UpdateFavoriteStore
      • DeleteSportPratice
      • AddSportPratice
      • GetFavoriteStore
    • Purchase
      • GetPurchase
    • Profile
      • UpdateProfile
      • GetProfile
    • Login
      • RefreshToken
      • RefreshMemberToken
      • UserToken
    • User
      • UserDataCpf
      • UserDataCpf
  • Member Login
  • Service Checkout APP
    • Full Vtex
      • OrderForm
      • Items
      • Profile
      • Update Payment Data
      • Start Transaction
      • Send Payment Data
      • Proccess Order
    • APP
      • Cart
        • Get Or Create orderForm
        • Add Cart Items
        • Remove Cart Items
      • Profile
        • Check Guest checkout Eligibility
        • Guest Add Profile Data
        • Autenticated Profile
      • Shipping
        • Address
      • Payment
        • Guest Update Payment Method
          POST
        • Autenticated Update Payment Method
          POST
        • Guest Transaction
          POST
        • Autenticated Transaction
          POST
        • Send Payment Data
          POST
        • Process Order
          POST
      • Orderplaced
        • Autenticated OrderPlaced
        • Guest OrderPlaced
      • Shared
        • Clear orderForm Messages
        • Add Preference Data
        • Add Coupon
    • WEB
      • Create cart
      • Get cart
  • Service Omni
    • Orders
      • Get Orders
  • Service Events
    • List all events
  • Service app
    • Pix Email
      • Send Pix Email
  1. Payment

Guest Transaction

Developing
Testing Env
https://testing--decathlonstore.myvtex.com
Testing Env
https://testing--decathlonstore.myvtex.com
POST
/_v/private/v2/app/rn/checkout/pub/orderForm/{orderFormId}/transaction
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://testing--decathlonstore.myvtex.com/_v/private/v2/app/rn/checkout/pub/orderForm//transaction' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId": "31bbcbd618494ab09cfe5588d1126066",
    "savePersonalData": true,
    "optinNewsLetter": true,
    "value": 22310,
    "referenceValue": 22310,
    "interestValue": 0
}'
Response Response Example
{
    "orderFormId": "string",
    "salesChannel": "string",
    "loggedIn": true,
    "isCheckedIn": true,
    "storeId": null,
    "checkedInPickupPointId": null,
    "allowManualPrice": true,
    "canEditData": true,
    "userProfileId": "string",
    "userType": null,
    "ignoreProfileData": true,
    "value": 0,
    "messages": [
        "string"
    ],
    "items": [
        {
            "uniqueId": "string",
            "id": "string",
            "productId": "string",
            "productRefId": "string",
            "refId": "string",
            "ean": "string",
            "name": "string",
            "skuName": "string",
            "modalType": null,
            "parentItemIndex": null,
            "parentAssemblyBinding": null,
            "assemblies": [
                "string"
            ],
            "priceValidUntil": "string",
            "tax": 0,
            "price": 0,
            "listPrice": 0,
            "manualPrice": null,
            "manualPriceAppliedBy": null,
            "sellingPrice": 0,
            "rewardValue": 0,
            "isGift": true,
            "additionalInfo": {
                "dimension": null,
                "brandName": "string",
                "brandId": "string",
                "offeringInfo": null,
                "offeringType": null,
                "offeringTypeId": null
            },
            "preSaleDate": null,
            "productCategoryIds": "string",
            "productCategories": {
                "72371487": "string",
                "72371488": "string",
                "72371495": "string"
            },
            "quantity": 0,
            "seller": "string",
            "sellerChain": [
                "string"
            ],
            "imageUrl": "string",
            "detailUrl": "string",
            "components": [
                "string"
            ],
            "bundleItems": [
                "string"
            ],
            "attachments": [
                "string"
            ],
            "attachmentOfferings": [
                "string"
            ],
            "offerings": [
                "string"
            ],
            "priceTags": [
                "string"
            ],
            "availability": "string",
            "measurementUnit": "string",
            "unitMultiplier": 0,
            "manufacturerCode": null,
            "priceDefinition": {
                "calculatedSellingPrice": 0,
                "total": 0,
                "sellingPrices": [
                    {
                        "value": 0,
                        "quantity": 0
                    }
                ],
                "reason": null
            },
            "taxCode": "string",
            "additionalInformation": {
                "analytics": {
                    "amplitude": {
                        "gender": null,
                        "carc_quantity": null,
                        "cac_quantity": null,
                        "shopping_tool": null,
                        "availability": null,
                        "product_id": "string",
                        "name": "string",
                        "product_type": "string",
                        "seller_name": "string",
                        "brand": "string",
                        "sport": "string",
                        "universe": "string",
                        "department": "string",
                        "sub_department": "string",
                        "family": "string",
                        "list_price": 0,
                        "display_price": 0,
                        "color": "string",
                        "sku_code": "string",
                        "size": "string",
                        "quantity": 0,
                        "purchase_price": 0,
                        "purchase_value": 0
                    }
                },
                "color": "string",
                "size": "string",
                "sellerOffer": {
                    "price": 0,
                    "listPrice": 0,
                    "hasDiscount": true,
                    "cashPrice": 0,
                    "cashDiscountPercentage": 0
                }
            }
        }
    ],
    "selectableGifts": [
        "string"
    ],
    "totalizers": [
        {
            "id": "string",
            "name": "string",
            "value": 0
        }
    ],
    "shippingData": {
        "address": {
            "addressType": "string",
            "receiverName": "string",
            "addressId": "string",
            "isDisposable": true,
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "street": "string",
            "number": "string",
            "neighborhood": "string",
            "complement": "string",
            "reference": null,
            "geoCoordinates": [
                "string"
            ]
        },
        "logisticsInfo": [
            {
                "itemIndex": 0,
                "selectedSla": null,
                "selectedDeliveryChannel": "string",
                "addressId": "string",
                "slas": [
                    "string"
                ],
                "shipsTo": [
                    "string"
                ],
                "itemId": "string",
                "deliveryChannels": [
                    {
                        "id": "string"
                    }
                ]
            }
        ],
        "selectedAddresses": [
            {
                "addressType": "string",
                "receiverName": "string",
                "addressId": "string",
                "isDisposable": true,
                "postalCode": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "complement": "string",
                "reference": null,
                "geoCoordinates": [
                    "string"
                ]
            }
        ],
        "availableAddresses": [
            {
                "addressType": "string",
                "receiverName": "string",
                "addressId": "string",
                "isDisposable": true,
                "postalCode": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "complement": "string",
                "reference": "string",
                "geoCoordinates": [
                    "string"
                ]
            }
        ],
        "pickupPoints": [
            {
                "friendlyName": "string",
                "address": {
                    "addressType": "string",
                    "receiverName": null,
                    "addressId": "string",
                    "isDisposable": true,
                    "postalCode": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string",
                    "street": "string",
                    "number": "string",
                    "neighborhood": "string",
                    "complement": "string",
                    "reference": null,
                    "geoCoordinates": [
                        0
                    ]
                },
                "additionalInfo": "string",
                "id": "string",
                "isActive": null,
                "businessHours": [
                    {
                        "DayOfWeek": 0,
                        "OpeningTime": "string",
                        "ClosingTime": "string"
                    }
                ]
            }
        ],
        "contactInformation": [
            "string"
        ]
    },
    "clientProfileData": {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "document": "string",
        "documentType": "string",
        "phone": "string",
        "corporateName": null,
        "tradeName": null,
        "corporateDocument": null,
        "stateInscription": null,
        "corporatePhone": null,
        "isCorporate": true,
        "profileCompleteOnLoading": true,
        "profileErrorOnLoading": true,
        "customerClass": null
    },
    "paymentData": {
        "updateStatus": "string",
        "installmentOptions": [
            {
                "paymentSystem": "string",
                "bin": null,
                "paymentName": null,
                "paymentGroupName": null,
                "value": 0,
                "installments": [
                    {
                        "count": 0,
                        "hasInterestRate": true,
                        "interestRate": 0,
                        "value": 0,
                        "total": 0,
                        "sellerMerchantInstallments": [
                            {
                                "id": "string",
                                "count": 0,
                                "hasInterestRate": true,
                                "interestRate": 0,
                                "value": 0,
                                "total": 0
                            }
                        ]
                    }
                ]
            }
        ],
        "paymentSystems": [
            {
                "id": 0,
                "name": "string",
                "groupName": "string",
                "validator": {
                    "regex": "string",
                    "mask": "string",
                    "cardCodeRegex": "string",
                    "cardCodeMask": "string",
                    "weights": [
                        0
                    ],
                    "useCvv": true,
                    "useExpirationDate": true,
                    "useCardHolderName": true,
                    "useBillingAddress": true
                },
                "stringId": "string",
                "template": "string",
                "requiresDocument": true,
                "displayDocument": true,
                "isCustom": true,
                "description": null,
                "requiresAuthentication": true,
                "dueDate": "string",
                "availablePayments": null
            }
        ],
        "payments": [
            {
                "paymentSystem": "string",
                "bin": null,
                "accountId": null,
                "tokenId": null,
                "installments": 0,
                "referenceValue": 0,
                "value": 0,
                "merchantSellerPayments": [
                    {
                        "id": "string",
                        "installments": 0,
                        "referenceValue": 0,
                        "value": 0,
                        "interestRate": 0,
                        "installmentValue": 0
                    }
                ]
            }
        ],
        "giftCards": [
            {
                "redemptionCode": null,
                "provider": "string",
                "value": 0,
                "balance": 0,
                "name": "string",
                "caption": "string",
                "id": "string",
                "inUse": true,
                "isSpecialCard": true,
                "groupName": "string"
            }
        ],
        "giftCardMessages": [
            "string"
        ],
        "availableAccounts": [
            "string"
        ],
        "availableTokens": [
            "string"
        ],
        "availableAssociations": {}
    },
    "marketingData": {
        "utmSource": "string",
        "utmMedium": "string",
        "utmCampaign": null,
        "utmipage": null,
        "utmiPart": null,
        "utmiCampaign": "string",
        "coupon": null,
        "marketingTags": [
            "string"
        ]
    },
    "sellers": [
        {
            "id": "string",
            "name": "string",
            "logo": "string"
        }
    ],
    "clientPreferencesData": {
        "locale": "string",
        "optinNewsLetter": true
    },
    "commercialConditionData": null,
    "storePreferencesData": {
        "countryCode": "string",
        "saveUserData": true,
        "timeZone": "string",
        "currencyCode": "string",
        "currencyLocale": 0,
        "currencySymbol": "string",
        "currencyFormatInfo": {
            "currencyDecimalDigits": 0,
            "currencyDecimalSeparator": "string",
            "currencyGroupSeparator": "string",
            "currencyGroupSize": 0,
            "startsWithCurrencySymbol": true
        }
    },
    "giftRegistryData": null,
    "openTextField": null,
    "invoiceData": null,
    "customData": null,
    "itemMetadata": {
        "items": [
            {
                "id": "string",
                "seller": "string",
                "name": "string",
                "skuName": "string",
                "productId": "string",
                "refId": "string",
                "ean": "string",
                "imageUrl": "string",
                "detailUrl": "string",
                "assemblyOptions": [
                    "string"
                ]
            }
        ]
    },
    "hooksData": null,
    "ratesAndBenefitsData": {
        "rateAndBenefitsIdentifiers": [
            "string"
        ],
        "teaser": [
            "string"
        ]
    },
    "subscriptionData": null,
    "merchantContextData": null,
    "purchaseAgentsData": null,
    "itemsOrdination": null
}

Request

Path Params
orderFormId
string 
required
Example:
{{orderFormId}}
Body Params application/json
referenceId
string 
required
orderFormId
savePersonalData
boolean 
required
optinNewsLetter
boolean 
required
value
integer 
required
Cart value
referenceValue
integer 
required
Cart Value
interestValue
integer 
required
Examples

Responses

🟢200Success
application/json
Body
orderFormId
string 
optional
salesChannel
string 
optional
loggedIn
boolean 
optional
isCheckedIn
boolean 
optional
storeId
null 
optional
checkedInPickupPointId
null 
optional
allowManualPrice
boolean 
optional
canEditData
boolean 
optional
userProfileId
string  | null 
optional
userType
null 
optional
ignoreProfileData
boolean 
optional
value
integer 
optional
messages
array[string]
optional
items
array [object {43}] 
optional
uniqueId
string 
optional
id
string 
optional
productId
string 
optional
productRefId
string 
optional
refId
string 
optional
ean
string 
optional
name
string 
optional
skuName
string 
optional
modalType
null 
optional
parentItemIndex
null 
optional
parentAssemblyBinding
null 
optional
assemblies
array[string]
optional
priceValidUntil
string 
optional
tax
integer 
optional
price
integer 
optional
listPrice
integer 
optional
manualPrice
null 
optional
manualPriceAppliedBy
null 
optional
sellingPrice
integer 
optional
rewardValue
integer 
optional
isGift
boolean 
optional
additionalInfo
object 
optional
preSaleDate
null 
optional
productCategoryIds
string 
optional
productCategories
object 
optional
quantity
integer 
optional
seller
string 
optional
sellerChain
array[string]
optional
imageUrl
string 
optional
detailUrl
string 
optional
components
array[string]
optional
bundleItems
array[string]
optional
attachments
array[string]
optional
attachmentOfferings
array[string]
optional
offerings
array[string]
optional
priceTags
array[string]
optional
availability
string 
optional
measurementUnit
string 
optional
unitMultiplier
integer 
optional
manufacturerCode
null 
optional
priceDefinition
object 
optional
taxCode
string 
optional
additionalInformation
object 
optional
selectableGifts
array[string]
optional
totalizers
array [object {3}] 
optional
id
string 
optional
ID
name
string 
optional
name
value
number 
optional
shippingData
object  | null 
optional
address
object  | null 
optional
logisticsInfo
array [object {8}]  | null 
optional
selectedAddresses
array [object {14}]  | null 
optional
availableAddresses
array [object {14}]  | null 
optional
pickupPoints
array [object {6}]  | null 
optional
contactInformation
array[string] | null 
optional
clientProfileData
object  | null 
optional
email
string 
optional
firstName
string 
optional
lastName
string 
optional
document
string 
optional
documentType
string 
optional
phone
string 
optional
corporateName
null 
optional
tradeName
null 
optional
corporateDocument
null 
optional
stateInscription
null 
optional
corporatePhone
null 
optional
isCorporate
boolean 
optional
profileCompleteOnLoading
boolean 
optional
profileErrorOnLoading
boolean 
optional
customerClass
null 
optional
paymentData
object  | null 
optional
updateStatus
string 
optional
installmentOptions
array [object {6}] 
optional
paymentSystems
array [object {13}] 
optional
payments
array [object {8}] 
optional
giftCards
array [object {10}] 
optional
giftCardMessages
array[string]
optional
availableAccounts
array[string]
optional
availableTokens
array[string]
optional
availableAssociations
object 
optional
marketingData
object  | null 
optional
utmSource
string  | null 
optional
utmMedium
string  | null 
optional
utmCampaign
null 
optional
utmipage
null 
optional
utmiPart
null 
optional
utmiCampaign
string  | null 
optional
coupon
null 
optional
marketingTags
array[string | null] | null 
optional
sellers
array [object {3}] 
optional
id
string  | null 
optional
name
string  | null 
optional
logo
string  | null 
optional
clientPreferencesData
object  | null 
optional
locale
string  | null 
optional
optinNewsLetter
boolean  | null 
optional
commercialConditionData
null 
optional
storePreferencesData
object 
optional
countryCode
string 
optional
saveUserData
boolean 
optional
timeZone
string 
optional
currencyCode
string 
optional
currencyLocale
integer 
optional
currencySymbol
string 
optional
currencyFormatInfo
object 
optional
giftRegistryData
null 
optional
openTextField
null 
optional
invoiceData
null 
optional
customData
null 
optional
itemMetadata
object  | null 
optional
items
array [object {10}]  | null 
optional
hooksData
null 
optional
ratesAndBenefitsData
object 
optional
rateAndBenefitsIdentifiers
array[string]
optional
teaser
array[string]
optional
subscriptionData
null 
optional
merchantContextData
null 
optional
purchaseAgentsData
null 
optional
itemsOrdination
null 
optional
Previous
Autenticated Update Payment Method
Next
Autenticated Transaction
Built with