Confirmação de Pagamento de Boleto Bancário

Este endpoint permite realizar a confirmação do pagamento de boleto bancário.

Boleto bancário

É o boleto bancário convencional (linhas digitáveis não iniciadas com dígito 8). Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.

Request

Request Endpoint

ENDPOINT

/account/ACCOUNT_KEY/payment/PAYMENT_KEY/bank_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

Request Body: Confirmação de pagamento de boleto bancário

{
  "token": "329adf"
}

Body Params

Campo	Tipo	Descrição
token *	string	Código de autenticação enviado ao aprovador de movimentações da conta

Response

Success Response

STATUS

200

Response Body: Pagamento executado

{
   "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
   "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
   "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
   "payer_document_number":"00037025000160",
   "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
   "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
   "transaction_revert_key":null,
   "paid_amount":1050.1,
   "payment_date":"2024-04-03",
   "payment_type":"bank_slip",
   "bank_slip": {
        "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
        "barcode":"00193967000009910000000003615574000000002417",
        "digitable_line":"00190000090361557400500000024174396700000991000",
        "payer_name":"COOPERATIVA TESTE",
        "payer_document_number":"00037025000160",
        "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_document_number":"52069937000117",
        "beneficiary_bank_ispb":"00000000",
        "guarantor_name":null,
        "guarantor_document_number":null,
        "factual_expiration_date":"2024-03-29",
        "expiration_date":"2024-03-29",
        "partial_payment_indicator":"allowed",
        "partial_payment_number":99,
        "registered_payment_number":0,
        "registered_payment_amount":9029.0,
        "nominal_amount":9910.0,
        "total_amount":10129.1,
        "rebate_amount":0.0,
        "discount_amount":0.0,
        "fine_amount":0.0,
        "interest_amount":219.1
    },
   "collection_slip":null,
   "payment_status":"executed"
}

STATUS

202

Response Body: Pagamento pendente de execução

{
   "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
   "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
   "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
   "payer_document_number":"00037025000160",
   "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
   "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
   "transaction_revert_key":null,
   "paid_amount":1050.1,
   "payment_date":"2024-04-03",
   "payment_type":"bank_slip",
   "bank_slip": {
        "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
        "barcode":"00193967000009910000000003615574000000002417",
        "digitable_line":"00190000090361557400500000024174396700000991000",
        "payer_name":"COOPERATIVA TESTE",
        "payer_document_number":"00037025000160",
        "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_document_number":"52069937000117",
        "beneficiary_bank_ispb":"00000000",
        "guarantor_name":null,
        "guarantor_document_number":null,
        "factual_expiration_date":"2024-03-29",
        "expiration_date":"2024-03-29",
        "partial_payment_indicator":"allowed",
        "partial_payment_number":99,
        "registered_payment_number":0,
        "registered_payment_amount":9029.0,
        "nominal_amount":9910.0,
        "total_amount":10129.1,
        "rebate_amount":0.0,
        "discount_amount":0.0,
        "fine_amount":0.0,
        "interest_amount":219.1
    },
   "collection_slip":null,
   "payment_status": "pending_execution"
}

Informação

Caso seja retornado HTTP Status 202 com o campo payment_status com valor pending_execution, o pagamento não deve ser retentado.

Este pagamento será processado assincronamente. É necessário verificar o status da transferência por meio da consulta de pagamento, ou aguardar envio do webhook de pagamento pendente descrito na página de webhooks.

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 collection_slip não se aplica para o fluxo de boletos bancários, assim como o objeto collection_slip que sempre será nulo.

Enumeradores payment_status

Enumerador	Tipo	Descrição
pending_execution	string	Pendente de execução
executed	string	Executado
reverted	string	Revertido
rejected	string	Rejeitado
error	string	Erro

Aviso

Para pagamentos aonde a QI não receber uma resposta da CIP em até dois minutos, o pagamento será retornado com o status pending_execution. Após a QI receber a resposta da CIP, será enviado para o cliente o webhook de pagamento pendente descrito na página de webhooks.

Objeto bank_slip

Campo	Tipo	Descrição
barcode *	string	Código de barras.
digitable_line *	string	Linha digitável.
payer_name *	string	Nome do pagador.
payer_document_number *	string	Número do documento do pagador (CPF/CNPJ).
beneficiary_name *	string	Nome do beneficiário.
beneficiary_trading_name	string	Nome fantasia do beneficiário.
beneficiary_document_number *	string	Número do documento do beneficiário (CPF/CNPJ).
beneficiary_bank_ispb *	string	Código ispb do banco do beneficiário.
guarantor_name	string	Nome do sacador avalista.
guarantor_document_number	string	Número do documento do sacador avalista (CPF/CNPJ).
factual_expiration_date *	string	Data de vencimento real.
expiration_date *	string	Data de vencimento original.
partial_payment_indicator *	enum	Indicador de pagamento parcial.
partial_payment_number	string	Quantidade de pagamentos parciais.
registered_payment_number	string	Quantidade de pagamentos registrados.
registered_payment_amount	string	Valor total de pagamentos registrados.
nominal_amount *	number	Valor original.
total_amount *	number	Valor total.
rebate_amount *	number	Valor do batimento.
discount_amount *	number	Valor do desconto.
fine_amount *	number	Valor da multa.
interest_amount *	number	Valor do juros.

Enumeradores partial_payment_indicator

Enumerador	Tipo	Descrição
allowed	string	Permitido
not_allowed	string	Não permitido

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	BIP000022	Bad Request	Bank slip payment service is closed.	Serviço de pagamento de boleto está fechado.
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	BIP000025	Bad Request	It was not possible to pay the bank slip at this time. Please verify your information and, if necessary, contact us for assistance.	Não foi possível pagar o boleto neste momento. Por favor, verifique suas informações e, se necessário, entre em contato conosco para assistência.
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.
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	BIP000062	Bad Request	Payment type is not bank slip.	Tipo de pagamento não é boleto.
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.