Cobranças - Criar cobrança

Gera uma única cobrança (Boleto, PIX ou Débito) para uma ou mais parcelas.

Importante: Mesmo quando múltiplos installment_ids são fornecidos, apenas um QR Code ou Boleto é gerado para o valor total combinado. Quando o cliente paga, o pagamento é automaticamente dividido entre as parcelas selecionadas e cada uma é liquidada individualmente.

Para o fluxo de pagamento mensal regular, prefira usar Faturas (que já consolidam as parcelas). Use este endpoint para cobrança avulsa de parcelas específicas fora do ciclo de fatura.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

Identificador do plano de pagamento

installment_ids
array of strings
required

Lista de IDs de parcelas para cobrar

installment_ids*
string
enum
required

Método de pagamento a gerar

Show Details
PIXPagamento instantâneo via PIX (sistema de pagamentos instantâneos do Banco Central). Retorna QR Code e código copia e cola.
BOLETOBoleto Bancário. Retorna código de barras, linha digitável e URL do PDF.
Allowed:
string

Identificador de pagamento do parceiro para reconciliação

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json