Referência

Checkout

Checkout hospedado com itens, métodos, cupons e campos personalizados.

Exige o produto CHECKOUT ativo para a empresa em Produção. No Sandbox basta não estar desativado.

GET/v1/checkouts

Lista checkouts

Escopo checkout.manage

Parâmetros de consulta

page

inteiroPágina (começa em 1).

pageSize

inteiro ≤ 200Itens por página (padrão 25).

POST/v1/checkouts

Cria checkout

Escopo checkout.manage

Corpo (JSON)

nameobrigatório

stringNome interno e título da página.

itemsobrigatório

listaname, unitAmount (centavos, string), quantity.

methodsobrigatório

listaPIX, BOLETO, CREDIT_CARD, DEBIT_CARD, CRYPTO.

maxInstallments

inteiro 1–12Parcelas no cartão.

allowCoupons

booleanoAceita cupom.

customFields

listakey, label, required.

theme

objetoaccent (#RRGGBB), mode (light | dark).

returnUrl / webhookUrl

URLRetorno após pagamento e notificação específica.

expiresAt

ISO 8601Validade.

GET/v1/checkouts/:id

Consulta checkout

Escopo checkout.manage

PATCH/v1/checkouts/:id

Atualiza checkout

Escopo checkout.manage

DELETE/v1/checkouts/:id

Arquiva checkout

Escopo checkout.manage

GET/v1/checkouts/:id/stats

Visitas, conversão e volume

Escopo checkout.manage