Resend payment confirmation token for Boleto

This endpoint allows the resending of the authentication token for Boleto payments.

Boleto

This is the conventional boleto (with digitable lines not starting with the digit 8). It is registered with the Interbank Payment Clearinghouse (CIP/Núclea) and can be paid at financial institutions and payment institutions authorized to operate by the Central Bank.

Request

Request Endpoint

ENDPOINT

/account/ACCOUNT_KEY/payment/PAYMENT_KEY/bank_slip/resend_token

MÉTODO

PATCH

Request Path Params

Field	Type	Description	Characters
account_key *	uuid4	Unique account identification key.	36
payment_key *	uuid4	Unique payment identification key.	36

Response

Success Response

STATUS

200

Response Body: Token successfully resent

{
   "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,
        "expiration_date":"2024-03-29",
        "max_payment_data": "2026-03-29",
        "partial_payment_indicator":"allowed",
        "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_2fa_approval"
}

Response Body Params

Field	Type	Description
payment_key *	uuid4	Unique payment identification key.
request_control_key *	uuid4	Unique identification key for the client's request.
payer_name *	string	Name of the effective payer.
payer_document_number *	string	Document number of the effective payer (CPF/CNPJ).
source_account_key *	uuid4	Key of the debited account.
transaction_key *	uuid4	Payment transaction key.
transaction_revert_key	uuid4	Payment reversal transaction key.
paid_amount *	number	Amount effectively paid.
payment_date *	string	Payment date.
payment_type *	enum	Payment type.
bank_slip	object	Boleto.
collection_slip	object	Collection invoice.
payment_status *	enum	Payment status.

Enumerators payment_type

Enumerator	Type	Description
bank_slip	string	Boleto
collection_slip	string	Collection invoice

Warning

The enumerator collection_slip does not apply to the boleto flow, and the collection_slip object will always be null.

Enumerators payment_status

Enumerator	Description
pending_2fa_approval	pending two-factor approval

Object bank_slip

Field	Type	Description
barcode *	string	Barcode.
digitable_line *	string	Digitable line.
payer_name *	string	Payer's name.
payer_document_number *	string	Payer's document number (CPF/CNPJ).
beneficiary_name *	string	Beneficiary's name.
beneficiary_trading_name	string	Beneficiary's trade name.
beneficiary_document_number *	string	Beneficiary's document number (CPF/CNPJ).
beneficiary_bank_ispb *	string	ISPB code of the beneficiary's bank.
guarantor_name	string	Name of the guarantor.
guarantor_document_number	string	Guarantor's document number (CPF/CNPJ).
expiration_date *	string	Due date.
max_payment_date *	string	Maximum payment date.
partial_payment_indicator *	enum	Partial payment indicator.
registered_payment_amount	string	Total registered payment amount.
nominal_amount *	number	Original amount.
total_amount *	number	Total amount.
rebate_amount *	number	Rebate amount.
discount_amount *	number	Discount amount.
fine_amount *	number	Fine amount.
interest_amount *	number	Interest amount.

Enumerators partial_payment_indicator

Enumerator	Type	Description
allowed	string	Allowed
not_allowed	string	Not allowed

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

HTTP Code	QI Code	Title	Description (eng)	Description (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.
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	BIP000062	Bad Request	Payment type is not bank slip.	Tipo de pagamento não é boleto.
400	BIP000064	Bad Request	Error resending verification token	Erro ao reenviar token de verificação
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.