Criar um Checkout
Cria um Checkout para o cliente realizar o pagamento.
url para redirecionar o cliente.
Obrigatório
items é obrigatório — lista com id do produto e quantity.Authorizations
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.
Body
Lista de itens incluídos na cobrança. Este é o único campo obrigatório — o valor total é calculado a partir destes itens.
1Métodos de pagamento disponíveis. Padrão ["PIX", "CARD"].
1PIX, CARD, BOLETO URL para onde o cliente será redirecionado ao clicar em "Voltar" no checkout.
URL para onde o cliente será redirecionado após o pagamento ser concluído.
ID de um cliente já cadastrado na sua loja. Se informado, o checkout será pré-preenchido com os dados deste cliente.
Exemplo: "cust_abcdefghij"
Lista de cupons que podem ser utilizados nesta cobrança.
Exemplo: ["ABKT10", "ABKT5", "PROMO10"]
50ID da cobrança no seu sistema, caso queira manter uma referência própria.
Exemplo: "seu_id_123"
ID de um produto avulso (sem cycle) a ser ofertado como upsell após a conclusão do pagamento.
O produto deve estar com status: ACTIVE e não pode ter cycle — apenas produtos de pagamento único são aceitos.
Exemplo: "prod_bump456xyz"
Data de vencimento do boleto no formato YYYY-MM-DD (ex: "2026-08-15"). Opcional. Só é válido quando methods inclui BOLETO; ignorado nos demais métodos.
Se omitido, o vencimento padrão é de 3 dias úteis. Não pode ser data no passado. Máximo de 365 dias no futuro.
"2026-08-15"
Juros por atraso, aplicados apenas quando methods inclui BOLETO. Ignorado para PIX/CARD.
Multa por atraso, aplicada apenas quando methods inclui BOLETO. Ignorado para PIX/CARD.
Metadados adicionais da cobrança. Campo livre para a sua aplicação.
Exemplo: