Edição

A instrução de edição serve para modificar dados configuráveis do boleto após sua emissão, como configurações de baixa automática, protesto, protesto falimentar e dados do pagador. Esta instrução permite atualizar múltiplos aspectos do boleto em uma única requisição.

Atenção!

O boleto deve estar no status 'registered' para que seja possível editá-lo. Ao menos um dos campos de dados (write_off_data, protest_data, bankruptcy_protest_data ou payer_data) deve ser informado junto com o request_control_key.

Request

ENDPOINT

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

MÉTODO

POST

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36
bank_slip_key	uuidv4	Chave única de identificação do boleto, no formato uuid v4	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

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
write_off_data	object	Configurações de baixa automática (null para remover)	Objeto write_off_data
protest_data	object	Configurações de protesto (null para remover)	Objeto protest_data
bankruptcy_protest_data	object	Configurações de protesto falimentar (null para remover)	Objeto bankruptcy_protest_data
payer_data	object	Dados do pagador (address null ou contact null para remover)	Objeto payer_data

Observação

Pelo menos um dos campos de dados (write_off_data, protest_data, bankruptcy_protest_data ou payer_data) deve ser informado na requisição.

Objeto write_off_data

Campo	Tipo	Descrição	Caracteres
days_to_write_off *	integer	Dias, após o vencimento, para que o boleto seja baixado automaticamente	-

Objeto protest_data

Campo	Tipo	Descrição	Caracteres
days_to_protest *	integer	Dias, após o vencimento, para que o boleto seja protestado automaticamente	-

Objeto bankruptcy_protest_data

Campo	Tipo	Descrição	Caracteres
days_to_bankruptcy_protest *	integer	Dias, após o vencimento, para que o boleto seja protestado automaticamente	-

Objeto payer_data

Campo	Tipo	Descrição	Caracteres
contact	object	Informações de contato	Objeto contact
address	object	Endereço	Objeto address

Objeto contact

Campo	Tipo	Descrição	Caracteres
email	string	E-mail de contato	320
phone	object	Telefone de contato	Objeto phone

Objeto phone

Campo	Tipo	Descrição	Caracteres
international_dial_code *	string	Código DDI (Discagem Direta Internacional)	3
area_code *	string	Código DDD (Discagem Direta à Distância)	2
number *	string	Complemento	9

Objeto address

Campo	Tipo	Descrição	Caracteres
street *	string	Logradouro	500
number *	string	Número	6
complement	string	Complemento	500
neighborhood *	string	Bairro	100
postal_code *	string	CEP	8
city *	string	Cidade	100
state *	string	Estado (UF)	Enumerador state

Enumeradores state

Enumerador	Descrição
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	Exceção

Response

STATUS

200

Response Body

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

Response Body Params

Campo	Tipo	Descrição	Caracteres
occurrence_key *	uuidv4	Chave única de identificação da ocorrência (instrução) no formato uuid v4	36
bank_slip_key *	uuidv4	Chave única de identificação do boleto no formato uuid v4	36

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (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'.