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

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta.	36
payment_key *	uuid4	Chave única de identificação do pagamento.	36

Autenticação via Email e SMS

Request Body: Confirmação de pagamento de fatura de recolhimento

{
  "token": "329adf"
}

Autenticação via Dispositivo

Para aprovar e finalizar a autenticação via dispositivo, a requisição deve ser enviada com um payload vazio. A validação ocorre internamente, sem necessidade de informações adicionais no corpo da requisição. É importante destacar que este endpoint só deve ser utilizado após a solicitação de transação ter sido iniciada.

Request Body: Confirmação de pagamento de fatura de recolhimento

{

}

Body Params

Campo	Tipo	Descrição	Caracteres
token	string	Código de autenticação enviado ao aprovador de movimentações da conta obrigatório para TFA via SMS ou e-mail	6

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

Campo	Tipo	Descrição
payment_key *	uuid4	Chave única de identificação do pagamento.
request_control_key *	uuid4	Chave única de identificação da request do cliente.
payer_name *	string	Nome do pagador efetivo.
payer_document_number *	string	Número do documento do pagador efetivo (CPF/CNPJ).
source_account_key *	uuid4	Chave da conta debitada.
transaction_key *	uuid4	Chave da transação do pagamento.
transaction_revert_key	uuid4	Chave da transação de reversão do pagamento.
paid_amount *	number	Valor pago efetivamente.
payment_date *	string	Data do pagamento.
payment_type *	enum	Tipo do pagamento.
bank_slip	object	Boleto bancário.
collection_slip	object	Fatura de recolhimento.
payment_status *	enum	Status do pagamento.

Enumeradores payment_type

Enumerador	Tipo	Descrição
bank_slip	string	Boleto bancário
collection_slip	string	Fatura 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

Enumerador	Descrição
executed	Executado
reverted	Revertido
rejected	Rejeitado
error	Erro

Objeto collection_slip

Campo	Tipo	Descrição
barcode	string	Código de barras.
digitable_line	string	Linha digitável.
collection_name *	string	Nome do convênio.
collection_document_number	string	Número de documento do convênio (CPF/CNPJ).
expiration_date *	string	Data de vencimento.
total_amount *	number	Valor 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 HTTP	Código QI	Título	Descrição (eng)	Descrição (pt-br)
403	BIP000010	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BIP000011	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BIP000012	Bad Request	It 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.
400	BIP000013	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BIP000014	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BIP000023	Bad Request	The source account has insufficient balance. Payment cannot be made.	A conta de origem possui saldo insuficiente. Pagamento não pode ser realizado.
400	BIP000028	Bad Request	The source account has blocked balance. Payment cannot be made.	A conta de origem possui saldo em conta bloqueado. Pagamento não pode ser realizado.
400	BIP000034	Bad Request	Collection slip already paid.	Fatura de recolhimento já paga.
400	BIP000036	Bad Request	Covenant slip overdue.	Fatura de recolhimento vencida.
400	BIP000038	Bad Request	Outside of covenant payment hours.	Fora do horário de pagamento do convênio.
400	BIP000044	Bad Request	It 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.
400	BIP000045	Bad Request	Collection slip payment service is closed.	Serviço de pagamento de fatura de recolhimento está fechado.
404	BIP000056	Not Found	Payment not found.	Pagamento não encontrado.
400	BIP000057	Bad Request	Payment status is not pending approval.	Status de pagamento não é de aprovação pendente.
400	BIP000058	Bad Request	Error while validating verification token	Erro ao validar token de verificação
400	BIP000059	Bad Request	Number of verification token validation attempts exceeded.	Número de tentativas de validação de token de verificação excedido.
400	BIP000060	Bad Request	Verification token expired.	Token de verificação expirado.
400	BIP000061	Bad Request	Verification token validation failed.	Falha na validação do token de verificação.
400	BIP000063	Bad Request	Payment type is not collection slip.	Tipo de pagamento não é fatura de recolhimento.
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.
400	BIP000080	Bad Request	A token is required for SMS or email validation.	Um token é necessário para validação via SMS ou email.