Skip to main content
O Checkout é a página de pagamento utilizada pelo seu cliente. Após enviar os dados da cobrança, a API retorna uma URL que pode ser utilizada para redirecionar o usuário e concluir o pagamento.
Crie cobranças Pix e consulte as cobranças pertencentes ao merchant associado à API key.

Criar uma cobrança

Use /checkoutspara criar uma cobrança, o valor total da cobrança é calculado a partir dos itens e suas quantidades. Payload esperado para criação da cobrança
Resposta:
Use a URL retornada no campo checkoutUrl para levar o cliente ao checkout e concluir o pagamento.

Status do checkout

O campo status representa o estado atual do checkout durante o fluxo de pagamento.

WAITING_CUSTOMER

O checkout foi criado e está aguardando que o cliente acesse a página de pagamento.
O cliente confirmou as informações e o checkout está pronto para gerar a cobrança.
O pagamento foi iniciado e está sendo processado.
A cobrança foi criada e está aguardando o pagamento do cliente.
O pagamento está em análise antes da confirmação final.
O prazo para pagamento expirou e o checkout não pode mais ser utilizado.
O checkout foi cancelado e não aceitará novos pagamentos.
O pagamento não pôde ser concluído.
O pagamento foi estornado total ou parcialmente.
O status do checkout pode ser acompanhado consultando a API ou através dos Webhooks, permitindo que sua aplicação seja notificada automaticamente sempre que ocorrer uma alteração.