Pular para o conteúdo principal

Realizar Pagamento de Fatura de Recolhimento (convênio/tributo)

Este endpoint permite realizar o pagamento de faturas de recolhimento. O pagamento deve ser realizado após a consulta, utilizando as informações retornadas na mesma, para garantir o funcionamento correto do fluxo evitando falhas durante o processo de pagamento.

Fatura de recolhimento

Esse tipo de cobrança é emitido por concessionárias de serviços (conta de água, luz, telefone e gás) e órgão públicos (tributos). Eles não são registrados na Câmara Interbancária de Pagamento (CIP/Núclea), por isso, não retornam as mesmas informações que um Boleto bancário apresenta.

Request​

Request Endpoint​

ENDPOINT
/account/ACCOUNT_KEY/payment/collection_slip
MÉTODO
POST

Request Path Params​

CampoTipoDescriçãoCaracteres
account_key *uuid4Chave única de identificação da conta.36
Request Body: Pagamento de fatura de recolhimento com linha digitável
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "digitable_line": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8
}
Request Body: Pagamento de fatura de recolhimento com código de barras
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "barcode": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8
}

Body Params​

CampoTipoDescrição
request_control_key *uuid4Chave única de identificação da request do cliente.
barcodestringCódigo de barras.
digitable_linestringLinha digitável.
payment_amount *numberValor a ser pago.
Aviso

O payment_amount deve sempre igual ao total_amount retornado na consulta do boleto bancário.

Response​

Success Response​

STATUS
201
Response Body: Pagamento executado
{
  "payment_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
  "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
  "payer_name": "COOPERATIVA INDUSTRIAL MURILO",
  "payer_document_number": "62069937000118",
  "source_account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
  "transaction_key": "fc9ccfd0-2f21-4207-9772-69238be74152",
  "transaction_revert_key": null,
  "paid_amount": 1389.21,
  "payment_date": "2024-04-30",
  "payment_type": "collection_slip",
  "bank_slip": null,
  "collection_slip": {
    "barcode": null,
    "digitable_line": "836200000138892100450006762142420244046000010192",
    "collection_name": "CIA ULTRAGAZ SA-COD",
    "collection_document_number": "00394460005887",
    "expiration_date": "2024-04-15",
    "total_amount": 1389.21
  },
  "payment_status": "executed"
}

Response Body Params​

CampoTipoDescrição
payment_key *uuid4Chave única de identificação do pagamento.
request_control_key *uuid4Chave única de identificação da request do cliente.
payer_name *stringNome do pagador efetivo.
payer_document_number *stringNúmero de documento do pagador efetivo (CPF/CNPJ).
source_account_key *uuid4Chave da conta debitada.
transaction_key *uuid4Chave da transação do pagamento.
transaction_revert_keyuuid4Chave da transação de reversão do pagamento.
paid_amount *numberValor pago efetivamente.
payment_date *stringData do pagamento.
payment_type *enumTipo do pagamento.
bank_slipobjectBoleto bancário.
collection_slipobjectFatura de recolhimento.
payment_status *enumStatus do pagamento.

Enumeradores payment_type​

EnumeradorTipoDescrição
bank_slipstringBoleto bancário
collection_slipstringFatura de recolhimento
Aviso

O enumerador bank_slip não se aplica para o fluxo de faturas de recolhimento, assim como o objeto bank_slip que sempre será nulo.

Enumeradores payment_status​

EnumeradorDescrição
executedExecutado
revertedRevertido
rejectedRejeitado
errorErro

Objeto collection_slip​

CampoTipoDescrição
barcodestringCódigo de barras.
digitable_linestringLinha digitável.
collection_name *stringNome do convênio.
collection_document_numberstringNúmero de documento do convênio (CPF/CNPJ).
expiration_date *stringData de vencimento.
total_amount *numberValor total.

Error Response​

STATUS
4XX
Response Body
{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}
Código HTTPCódigo QITítuloDescrição (eng)Descrição (pt-br)
400BIP000032Bad RequestThe bill sent does not correspond to a collection slip.A conta enviada não corresponde a uma fatura de recolhimento.
400BIP000033Bad RequestThe barcode or digitable line of the collection slip must have 44 or 48 characters.O código de barras ou linha digitável da fatura de recolhimento deve ter 44 ou 48 caracteres.
403BIP000010ForbiddenUser is not allowed to do this actionUsuário não tem autorização para fazer essa ação
404BIP000011Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BIP000012Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BIP000013Bad RequestThe source account is closed.A conta de origem está fechada.
400BIP000014Bad RequestThe source account is blocked.A conta de origem está bloqueada.
400BIP000023Bad RequestThe source account has insufficient balance. Payment cannot be made.A conta de origem possui saldo insuficiente. Pagamento não pode ser realizado.
400BIP000024Bad RequestRequest control key already exists.Chave de controle da requisição já existe.
400BIP000028Bad RequestThe source account has blocked balance. Payment cannot be made.A conta de origem possui saldo em conta bloqueado. Pagamento não pode ser realizado.
400BIP000034Bad RequestCollection slip already paid.Fatura de recolhimento já paga.
400BIP000035Bad RequestCovenant slip invalid barcode.Código de barras da fatura de recolhimento inválido.
400BIP000036Bad RequestCovenant slip overdue.Fatura de recolhimento vencida.
400BIP000037Bad RequestError in collection slip consultation.Erro na consulta da fatura de recolhimento.
400BIP000038Bad RequestOutside of covenant payment hours.Fora do horário de pagamento do convênio.
400BIP000039Bad RequestCollection slip not accepted.Fatura de recolhimento não aceita.
400BIP000040Bad RequestMinimum advance not reached.Mínimo de dias de adiantamento não atingido.
400BIP000041Bad RequestMax payment amount exceeded.Valor máximo de pagamento excedido.
400BIP000044Bad RequestIt was not possible to pay the collection slip at this time. Please verify your information and, if necessary, contact us for assistance.Não foi possível pagar a fatura de recolhimento neste momento. Por favor, verifique suas informações e, se necessário, entre em contato conosco para assistência.
400BIP000045Bad RequestCollection slip payment service is closed.Serviço de pagamento de fatura de recolhimento está fechado.

Ambiente de Sandbox​

Em nosso ambiente de sandbox, disponibilizamos linhas digitáveis mockadas para a simulação de pagamentos bem-sucedidos e testes de cenários de erro.

Cenários de sucesso​

Linha digitável
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

Cenários de erro​

Linha digitávelCódigo de erro
858500000037350000643217212883260006147448091022BIP000035