Skip to main content
Cria um pedido com produtos do seu catálogo e gera a cobrança Pix. Método: POST /api/v1/orders Autenticação: Obrigatória — inclua o header Authorization: Bearer sk_live_sua_api_key. A loja é identificada pela API key; não envie X-Store-ID. Escopo necessário: transaction.create.
Para o checkout público no seu frontend (sem API key), use POST /api/v1/orders/public, que identifica a loja pelo header X-Store-ID — os campos do corpo são os mesmos. Não use o endpoint público em integrações de backend autenticadas.

Parâmetros do corpo

string
required
Nome de quem está comprando.
string
required
E-mail do cliente. É por onde a entrega é enviada.
string
required
Use PIX.
object[]
required
Itens do pedido. Precisa ter ao menos um.
string
required
UUID do produto.
number
required
Quantidade, inteiro maior que zero.
string
UUID da variação. Obrigatório quando o produto é variable.
O preço não é enviado na requisição: vale sempre o preço cadastrado no produto. Isso impede que o valor seja alterado pelo lado do cliente.

Exemplo de requisição

Resposta

Exiba pix.qr_code como imagem e pix.copy_paste como texto copiável.

Idempotência

Envie o header Idempotency-Key para poder repetir a requisição com segurança. Uma repetição com a mesma chave devolve o mesmo pedido e o mesmo Pix, sem cobrar o cliente duas vezes.

Pagamento indisponível

Se o pedido for criado mas a cobrança falhar, a resposta traz pix: null e um campo warning. O pedido existe, mas não há como pagá-lo — crie outro.

Confirmar o pagamento

Assine o webhook payment.paid, ou consulte GET /api/v1/orders/:id com a mesma API key (escopo transaction.verify). Só libere o produto após a confirmação.