Pular para o conteúdo principal

Confirmação de Pagamento de Fatura de Recolhimento

Este endpoint permite realizar a confirmação do pagamento de faturas de recolhimento.

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/PAYMENT_KEY/collection_slip/validate_token
MÉTODO
PATCH

Request Path Params​

CampoTipoDescriçãoCaracteres
account_key *uuid4Chave única de identificação da conta.36
payment_key *uuid4Chave única de identificação do pagamento.36
Request Body: Confirmação de pagamento de fatura de recolhimento
{
  "token": "329adf"
}

Body Params​

CampoTipoDescrição
token *stringCódigo de autenticação enviado ao aprovador de movimentações da conta

Response​

Success Response​

STATUS
200
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 do 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)
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.
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.
400BIP000036Bad RequestCovenant slip overdue.Fatura de recolhimento vencida.
400BIP000038Bad RequestOutside of covenant payment hours.Fora do horário de pagamento do convênio.
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.
404BIP000056Not FoundPayment not found.Pagamento não encontrado.
400BIP000057Bad RequestPayment status is not pending approval.Status de pagamento não é de aprovação pendente.
400BIP000058Bad RequestError while validating verification tokenErro ao validar token de verificação
400BIP000059Bad RequestNumber of verification token validation attempts exceeded.Número de tentativas de validação de token de verificação excedido.
400BIP000060Bad RequestVerification token expired.Token de verificação expirado.
400BIP000061Bad RequestVerification token validation failed.Falha na validação do token de verificação.
400BIP000063Bad RequestPayment type is not collection slip.Tipo de pagamento não é fatura de recolhimento.
400BIP000065Bad RequestPayment verification time window exceeded.Janela de tempo de verificação de pagamento excedida.