Guia de Pagamento de Boletos

Criar pagamento

POST /v1/pagamentos/boletos — escopo multipag.boleto.pagar.

Campos do body:

Campo	Tipo	Obrigatório	Observações
codigoBarra	texto (44)	Sim	Código de barras do boleto
conta	texto	Sim	Conta com DV, sem traço
cooperativa	texto	Sim	4 dígitos, zeros à esquerda
dataPagamento	data	Sim	AAAA-MM-DD
documento	texto	Sim	CPF/CNPJ do associado (só números)
identificadorPagamentoAssociado	texto (máx. 100)	Sim	Identificador do associado
idTransacao	texto (máx. 100)	Sim	ID da transação
valorPagamento	decimal	Sim	Mín. 0, 2 casas decimais
cpfCnpjBeneficiario	texto	Não	Se informado, valida se é igual ao beneficiário do boleto (não o beneficiário final)

Exemplo de request com validação de beneficiário:

{
  "conta": "000001",
  "cooperativa": "0100",
  "documento": "11111111000111",
  "codigoBarra": "74892950500006000001123100010108100200003107",
  "dataPagamento": "2026-08-14",
  "valorPagamento": 6000,
  "identificadorPagamentoAssociado": "BOLETO SICREDI",
  "idTransacao": "0910BS125",
  "cpfCnpjBeneficiario": "22222222000222"
}

Exemplo de response (200 OK):

{
  "idPagamentoBoleto": "68b3df07-0571-4438-89dc-aca624368dee",
  "codigoBarra": "74892950500006000001123100010108100200003107",
  "dataPagamento": "2026-08-14",
  "valorPagamento": 6000,
  "identificadorPagamentoAssociado": "BOLETO SICREDI",
  "idTransacao": "0910BS125",
  "status": "RECEBIDO"
}

Cancelar pagamento agendado

PATCH /v1/pagamentos/boletos/cancelamentos, escopo multipag.boleto.pagar. Body: conta, cooperativa, documento, idTransacao. Retorno 200 OK com body vazio.

Buscar pagamento

GET /v1/pagamentos/boletos/{idTransacao} — escopo multipag.boleto.consultar. Headers: Authorization, x-conta, x-cooperativa, x-documento.

Buscar comprovante

GET /v1/pagamentos/boletos/{idTransacao}/comprovantes — escopo multipag.boleto.consultar. Disponível apenas para status SUCESSO. Retorna PDF binário, ver em Comprovantes.