Pagamentos

Esta página contém todos os endpoints da API Pagamento de contas Efí.

Detalhar código de barras para pagamento

Este endpoint deve ser usado para detalhar as informações vinculadas a um código de barras de qualquer tipo de cobrança. O uso deste endpoint é obrigatório antes de realizar um pagamento, pois ele ajuda a evitar erros no processamento.

Importante!

Há dois tipos de cobranças e elas podem retornar informações diferentes. São eles:

1. Tipo tributo – conhecido também como títulos e convênios, esse tipo de cobrança é emitido por concessionárias de serviços, como: conta de água, luz, telefone e gás. Eles não são registrados na Câmara Interbancária de Pagamento (CIP) e, por isso, não retornam as mesmas informações que um boleto registrado na CIP apresenta.
2. Tipo boleto – possui registro na Câmara Interbancária de Pagamento (CIP) e, por isso, após ser consultado, o endpoint retorna informações mais completas sobre o pagamento.

No item “Respostas”, a seguir, você confere o retorno das consultas que é apresentado em cada tipo de cobrança.

GET /v1/codBarras/:codBarras

Requer autorização para o escopo: gn.barcode.read

Requisição

Este endpoint utiliza query params em seu funcionamento, portanto devem ser enviados pela URL, como exemplificado no trecho de código abaixo.

/v1/codBarras/:codBarras

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo(400).

🟢 200 (Tipo boleto)

{
  "tipo": "boleto",
  "banco": {
    "codigo": 364,
    "nome": "EFI S.A."
  },
  "codBarras": "0000000000000000000000000000000000",
  "linhaDigitavel": "000000000000000000000000000000000",
  "datas": {
    "vencimento": "2021-06-22 14:23:42",
    "limitePagamento": "2021-09-22 14:23:42"
  },
  "beneficiario": {
    "nome": "João da Silva",
    "fantasia": "Padaria do João",
    "documento": "00000000000000"
  },
  "pagador": {
    "nome": "Gorbadock Oldbuck",
    "documento": "00000000000"
  },
  "valores": {
    "original": 1000,
    "abatimento": 0,
    "multa": 200,
    "juros": 2,
    "desconto": 300,
    "final": 902
  },
  "informacoesPagamento": {
    "divergente": {
      "deveAceitar": false,
      "valorMinimo": 0,
      "valorMaximo": 0
    },
    "parcial": {
      "deveAceitar": false,
      "limiteDePagamentos": 0
    },
    "podeSerPago": true
  }
}

🟢 200 (Tipo Tributo)

{
  "tipo": "tributo",
  "banco": null,
  "codBarras": "84620000000470000113222928260060772936353800",
  "linhaDigitavel": "846200000004470000113220292826006077729363538004",
  "datas": {
    "vencimento": "contraApresentacao",
    "limitePagamento": null
  },
  "beneficiario": null,
  "pagador": null,
  "sacadorAvalista": null,
  "valores": {
    "original": 4700,
    "abatimento": null,
    "pago": null,
    "final": 4700
  },
  "informacoesPagamento": null
}

🔴 400

UnknownRegisterError
{
  "erro": 0,
  "descricao": "Código de barras inválido"
}

Ou

{
  "nome": "erro_de_validacao",
  "mensagem": "Código de barras inválido"
}

Ou

{
  "mensagem": "must NOT have more than 48 characters"
}

Ou

{
  "mensagem": "must NOT have fewer than 44 characters"
}

Ou

{
  "nome": "Error",
  "mensagem": "must be number"
}

Ou

{
  "nome": "erro_de_validacao",
  "mensagem": "Código de barras não localizado na base centralizada"
}

Solicitar pagamento de código de barras

Este endpoint deve ser usado para solicitar o pagamento de um código de barras para a data atual ou futura.

Importante!

Para pagamento no mesmo dia, os boletos são aceitos até as 22 horas, com exceção dos boletos com valores superiores a R$249.000,00 que são aceitos até as 14 horas. No caso de contas de consumo (água, energia, TV a cabo, gás e telefone) e tributos, o processamento ocorre até às 18 horas. Mas, é possível agendá-los para o próximo dia útil.

POST /v1/codBarras/:codBarras

Requer autorização para o escopo: gn.barcode.pay.write

Requisição

Este endpoint utiliza query params em seu funcionamento, portanto devem ser enviados pela URL, como exemplificado no trecho de código abaixo.

/v1/codBarras/:codBarras

Exemplo

{
  "valor": 500,
  "dataPagamento": "2022-03-10",
  "descricao": "Pagamento de boleto, teste API Pagamento de Contas"
}

Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo(400).

🟢 201

{
  "idPagamento": "31234652",
  "valorPago": 500,
  "status": "LIQUIDADO",
  "data": {
    "solicitacao": "2021-06-22 14:23:42",
    "pagamento": "2021-06-25 13:03:20"
  }
}

🔴 400

{
  "erro": 0,
  "descricao": "Código de barras inválido"
}

Consultar solicitação de pagamento

Consulta o status da solicitação de pagamento anteriormente efetuada a partir do idPagamento.

GET /v1/:idPagamento

Requer autorização para o escopo: gn.barcode.pay.read

Requisição

Este endpoint utiliza query params em seu funcionamento, portanto devem ser enviados pela URL, como exemplificado no trecho de código abaixo.

/v1/:idPagamento

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo(400).

🟢 200 (LIQUIDADO)

{
  "idPagamento": "304578214",
  "valorPago": 1000,
  "status": "LIQUIDADO",
  "motivoRecusa": null,
  "data": {
    "solicitacao": "2021-09-22 14:23:42",
    "pagamento": "2021-09-22 10:23:42"
  }
}

🟢 200 (NÃO LIQUIDADO)

{
  "idPagamento": 524090299,
  "codBarras": "36400000000000000000000000000000000000000000",
  "linhaDigitavel": "36400000000000000000000000000000000000000000000",
  "valorPago": 2000,
  "status": "NAO_REALIZADO",
  "retornoBancario": "Limite mensal excedido.",
  "protocolo": null,
  "descricao": "EFI S.A.",
  "horario": {
    "solicitacao": "2022-04-01T12:47:04.000Z"
  }
}

🔴 400

{
  "erro": 0,
  "descricao": "Pagamento não encontrado"
}

Consultar resumo de solicitações de pagamento

Este endpoint deve ser usado para solicitar o resumo das solicitações de pagamento realizadas em um período informado.

GET /v1/resumo

Requer autorização para o escopo: gn.barcode.pay.read

Requisição

Este endpoint utiliza query params em seu funcionamento, portanto devem ser enviados pela URL, como exemplificado no trecho de código abaixo.

/v1/resumo

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo(400).

🟢 200

{
  "datas": {
    "inicial": "2022-04-01",
    "final": "2022-10-25"
  },
  "solicitacoes": {
    "total": 0,
    "processando": 0,
    "sucesso": 0,
    "falha": 0,
    "cancelada": 0
  },
  "solicitacoesFalhas": [
    0
  ]
}

🔴 400

{
  "nome": "erro_de_validacao",
  "mensagem": "A propriedade dataInicio é obrigatória"
}

Ou

{
  "nome": "erro_de_validacao",
  "mensagem": "A propriedade dataFim é obrigatória"
}