Criar pagamento

`POST /v1/pagamentos/tributos/barras, escopo multipag.tributos.pagar.`

Campos do body:

Campo	Tipo	Obrigatório	Observações
codigoBarra	texto (44)	Sim	Código de barras do tributo
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
idFgts	texto (máx. 50)	Condicional	Para FGTS, informar 0181; para outras modalidades, opcional
idTransacao	texto (máx. 100)	Sim	ID da transação
valorPagamento	decimal	Sim	Mín. 0, 2 casas decimais

Exemplo de request (instantâneo):

{
  "conta": "000001",
  "cooperativa": "0100",
  "documento": "11111111000111",
  "codigoBarra": "81610000001196248692023101183215529722698854",
  "dataPagamento": "2026-08-14",
  "valorPagamento": 119.62,
  "identificadorPagamentoAssociado": "EMP:0101",
  "idFgts": "123",
  "idTransacao": "0910TB1"
}

Exemplo de response (200 OK):

{
  "idPagamentoTributosBarra": "85d10b58-9b64-4019-a4e6-e41fc4bbfa58",
  "codigoBarra": "81610000001196248692023101183215529722698854",
  "dataPagamento": "2026-08-14",
  "valorPagamento": 119.62,
  "identificadorPagamentoAssociado": "EMP:0101",
  "idFgts": "123",
  "idTransacao": "0910TB1",
  "status": "RECEBIDO"
}

Para agendar, use uma dataPagamento futura, o response retorna status: "AGENDADO".

Cancelar pagamento agendado

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

Buscar pagamento

GET /v1/pagamentos/tributos/barras/{idTransacao} escopo multipag.tributos.consultar. Headers: Authorization, x-conta, x-cooperativa, x-documento. Retorna o pagamento com o status atual.

Buscar comprovante

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

Códigos de retorno de todas as operações em Códigos de erro.