Skip to main content
PATCH
Atualizar checkout

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

checkoutId
string
required

Identificador do checkout.

Minimum string length: 1

Body

application/json
isDefault
boolean

Torna este o checkout padrão do produto. Só em checkouts v1.

appearance
object

Bloco de aparência (cores, tema) da página. Nas duas gerações.

timer
object

Configuração do cronômetro de escassez. Só em checkouts v1.

banner
object

Banner do topo da página. Só em checkouts v1.

cta
object

Texto e estilo do botão de finalizar. Só em checkouts v1.

testimonials
object

Bloco de provas sociais e depoimentos. Só em checkouts v1.

allowedDoubleCard
boolean

Permite dividir o pagamento em dois cartões.

allowedCardPix
boolean

Permite pagar parte no cartão e parte no Pix.

allowedSmartInstallment
boolean

Liga o Parcelamento Inteligente.

acceptMethod
enum<string>[]

Meios de pagamento aceitos. Só em v2.

Minimum array length: 1

Meio de pagamento que pode ser ligado no checkout.

Available options:
pix,
credit_card
preferredPaymentMethod
enum<string> | null

Meio aberto por padrão. Só em v2.

Available options:
pix,
credit_card
maxInstallments
integer

Máximo de parcelas no cartão. Só em v2.

Required range: 1 <= x <= 12
defaultOfferId
integer | null

Oferta que abre pela URL. Só em v2.

Required range: x > 0
collectBuyerAddress
boolean

Pede o endereço do comprador. Só em v2.

askBuyerInstagram
boolean

Pede o Instagram do comprador. Só em v2.

enableAddressAutofill
boolean

Preenche o endereço pelo CEP. Só em v2.

collectInstagram
boolean

Coleta o Instagram do comprador. Só em v2.

upsellEnabled
boolean

Liga o funil pós-compra. Só em v2.

upsellRedirectUrl
string<uri> | null

Destino após a compra. Só em v2.

imageUrl
string

Imagem do produto exibida na página. Só em v2.

marketLanguage
string

Idioma/mercado da página. Só em v2.

invoiceName
string

Nome exibido na fatura do cartão. Só em v2.

billetExpireTime
integer

Legado: dias até o boleto vencer. A plataforma não emite mais boleto; o campo segue gravável para não perder a configuração de checkouts antigos. Só em v2.

Required range: x >= 1

Response

Checkout atualizado.

Checkout atualizado.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required