Cobranças

Os endpoints de Cobranças permitem criar, consultar e gerenciar cobranças vinculadas a clientes, além de executar ações sobre cobranças existentes e recuperar informações necessárias para disponibilizar o pagamento.

Operações disponíveis

  • Criação e cartão: crie cobranças, processe pagamentos com cartão no momento da criação ou posteriormente e capture cobranças com pré-autorização.
  • Consulta e dados de pagamento: liste ou recupere cobranças, consulte status e informações de pagamento ou visualização e obtenha a linha digitável do boleto ou o QR Code Pix.
  • Gerenciamento e ações: atualize, remova ou restaure cobranças e registre ou desfaça recebimentos confirmados em dinheiro.
  • Simulação e limites: simule condições de venda e consulte os limites aplicáveis à criação de cobranças.
  • Dados resumidos: utilize as operações com resposta resumida quando não precisar receber o objeto completo da cobrança.
📘

Acompanhamento de mudanças

Para acompanhar mudanças de estado das cobranças, utilize Webhooks em vez de consultar repetidamente os endpoints de listagem, recuperação ou status.

Consulte os eventos de Webhook para cobranças.

Para entender a jornada completa de criação e acompanhamento, consulte Introdução - Cobranças