Edit

The edit instruction serves to modify configurable data of the bank slip after its issuance, such as automatic write-off settings, protest, bankruptcy protest, and payer data. This instruction allows updating multiple aspects of the bank slip in a single request.

Attention!

The bank slip must be in 'registered' status for it to be editable. At least one of the data fields (write_off_data, protest_data, bankruptcy_protest_data or payer_data) must be provided along with the request_control_key.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/bank_slip_edit

METHOD

POST

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36
bank_slip_key	uuidv4	Unique bank slip identification key, in uuid v4 format	36

Request Body

{
  "request_control_key": "c4dd443a-6e2f-4261-8f28-adfa4c0d4c5b",
  "write_off_data": {"days_to_write_off": 365},
  "protest_data": {"days_to_protest": 7},
  "bankruptcy_protest_data": {"days_to_bankruptcy_protest": 14},
  "payer_data": {
    "contact": {
      "email": "finance@globaltech.com",
      "phone": {"international_dial_code": "055", "area_code": "11", "number": "987654321"},
    },
    "address": {
      "street": "101 High St.",
      "neighborhood": "Tech Park",
      "number": "202",
      "postal_code": "01001000",
      "city": "Innovation City",
      "state": "SP",
      "complement": "Building A",
    },
  },
}

Request Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format	36
write_off_data	object	Automatic write-off settings (null to remove)	write_off_data Object
protest_data	object	Protest settings (null to remove)	protest_data Object
bankruptcy_protest_data	object	Bankruptcy protest settings (null to remove)	bankruptcy_protest_data Object
payer_data	object	Payer data (address null or contact null to remove)	payer_data Object

Note

At least one of the data fields (write_off_data, protest_data, bankruptcy_protest_data or payer_data) must be provided in the request.

write_off_data Object

Field	Type	Description	Characters
days_to_write_off *	integer	Days, after due date, for the bank slip to be automatically written off	-

protest_data Object

Field	Type	Description	Characters
days_to_protest *	integer	Days, after due date, for the bank slip to be automatically protested	-

bankruptcy_protest_data Object

Field	Type	Description	Characters
days_to_bankruptcy_protest *	integer	Days, after due date, for the bank slip to be automatically protested	-

payer_data Object

Field	Type	Description	Characters
contact	object	Contact information	contact Object
address	object	Address	address Object

contact Object

Field	Type	Description	Characters
email	string	Contact email	320
phone	object	Contact phone	phone Object

phone Object

Field	Type	Description	Characters
international_dial_code *	string	International Direct Dialing Code	3
area_code *	string	Area Code	2
number *	string	Number	9

address Object

Field	Type	Description	Characters
street *	string	Street	500
number *	string	Number	6
complement	string	Complement	500
neighborhood *	string	Neighborhood	100
postal_code *	string	Postal Code	8
city *	string	City	100
state *	string	State	state Enumerator

state Enumerators

Enumerator	Description
AC	Acre
AL	Alagoas
AM	Amazonas
AP	Amapá
BA	Bahia
CE	Ceará
DF	Distrito federal
ES	Espírito Santo
GO	Goiás
MA	Maranhão
MG	Minas Gerais
MS	Mato Grosso do Sul
MT	Mato Grosso
PA	Pará
PB	Paraíba
PE	Pernambuco
PI	Piauí
PR	Paraná
RJ	Rio de Janeiro
RN	Rio Grande do Norte
RO	Rondônia
RR	Roraima
RS	Rio Grande do Sul
SC	Santa Catarina
SE	Sergipe
SP	São Paulo
TO	Tocantins
EX	Exception

Response

STATUS

200

Response Body

{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}

Response Body Params

Field	Type	Description	Characters
occurrence_key *	uuidv4	Unique occurrence (instruction) identification key in uuid v4 format	36
bank_slip_key *	uuidv4	Unique bank slip identification key in uuid v4 format	36

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
400	QIT000001	Bad Request	Schema Error	Schema Inválido
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	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	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada
409	BKS000014	Conflict	Request control key already sent or duplicated sent: <request_control_key>	Chave de controle da requisição já utilizada ou enviada duplicada: <request_control_key>
400	BKS000022	Bad Request	Requester profile is not opened.	Carteira não está aberta.
404	BKS000029	Not Found	Bank slip not found for the given key ({bank_slip_key}).	Boleto não encontrado para a chave fornecida ({bank_slip_key}).
400	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.