Skip to main content

Extension

The extension request serves to extend the due date of the bank slip.

Attention!

If there is any extension request pending confirmation, creating a new request is not allowed.

Request

ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/extension
METHOD
POST

Path parameters

FieldTypeDescriptionCharacters
account_keyuuidv4Unique account identification key, in uuid v4 format36
requester_profile_keyuuidv4Unique wallet identification key, in uuid v4 format36
bank_slip_keyuuidv4Unique bank slip identification key, in uuid v4 format36
Request Body
{
"request_control_key": "2e2f0053-a988-40c7-ad17-41c4c4da861e",
"new_expiration_date": "2025-01-01"
}

Request Body Params

FieldTypeDescriptionCharacters
request_control_key *uuidv4Unique request identification key used by the client in uuid v4 format36
new_expiration_date *stringNew expiration date, in "YYYY-MM-DD" format10

Response

STATUS
202
Response Body
{
"occurrence_key": "6f2eb385-898f-4fa3-96df-80a76a30ad01",
"bank_slip_key": "0d462dda-7412-444f-ace9-375e4ab43c2f"
}

Response Body Params

FieldTypeDescriptionCharacters
occurrence_key *uuidv4Unique occurrence (instruction) identification key in uuid v4 format36
bank_slip_key *uuidv4Unique bank slip identification key in uuid v4 format36

Error Response

STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP Code
status
QI Code
code
Title
title
Description (eng)
description
Description (pt-br)
translation
400QIT000001Bad RequestSchema ErrorSchema Inválido
404BKS000006Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BKS000007Bad 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.
400BKS000008Bad RequestThe source account is closed.A conta de origem está fechada.
400BKS000009Bad RequestThe source account is blocked.A conta de origem está bloqueada.
404BKS000013Not FoundRequester profile not foundCarteira não encontrada
409BKS000014ConflictRequest control key already sent or duplicated sent: <request_control_key>Chave de controle da requisição já utilizada ou enviada duplicada: <request_control_key>
400BKS000022Bad RequestRequester profile is not opened.Carteira não está aberta.
404BKS000029Not FoundBank slip not found for the given key ({bank_slip_key}).Boleto não encontrado para a chave fornecida ({bank_slip_key}).
400BKS000032Bad RequestBank slip must be in 'registered' status.O boleto deve possuir o status 'registered'.
400BKS000041Bad RequestThe new expiration date must be greater than the current expiration date.A nova data de expiração deve ser posterior à data de expiração atual.
409BKS000042ConflictThere is already a pending extension occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.Já existe uma ocorrência de extensão pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.