Skip to main content

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​

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta, no formato uuid v436
requester_profile_keyuuidv4Chave única de identificação da carteira, no formato uuid v436
bank_slip_keyuuidv4Chave única de identificação do boleto, no formato uuid v436
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​

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v436
write_off_dataobjectConfigurações de baixa automática (null para remover)Objeto write_off_data
protest_dataobjectConfigurações de protesto (null para remover)Objeto protest_data
bankruptcy_protest_dataobjectConfigurações de protesto falimentar (null para remover)Objeto bankruptcy_protest_data
payer_dataobjectDados 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​

CampoTipoDescriçãoCaracteres
days_to_write_off *integerDias, após o vencimento, para que o boleto seja baixado automaticamente-

Objeto protest_data​

CampoTipoDescriçãoCaracteres
days_to_protest *integerDias, após o vencimento, para que o boleto seja protestado automaticamente-

Objeto bankruptcy_protest_data​

CampoTipoDescriçãoCaracteres
days_to_bankruptcy_protest *integerDias, após o vencimento, para que o boleto seja protestado automaticamente-

Objeto payer_data​

CampoTipoDescriçãoCaracteres
contactobjectInformações de contatoObjeto contact
addressobjectEndereçoObjeto address

Objeto contact​

CampoTipoDescriçãoCaracteres
emailstringE-mail de contato320
phoneobjectTelefone de contatoObjeto phone

Objeto phone​

CampoTipoDescriçãoCaracteres
international_dial_code *stringCódigo DDI (Discagem Direta Internacional)3
area_code *stringCódigo DDD (Discagem Direta à Distância)2
number *stringComplemento9

Objeto address​

CampoTipoDescriçãoCaracteres
street *stringLogradouro500
number *stringNúmero6
complementstringComplemento500
neighborhood *stringBairro100
postal_code *stringCEP8
city *stringCidade100
state *stringEstado (UF)Enumerador state

Enumeradores state​

EnumeradorDescrição
ACAcre
ALAlagoas
AMAmazonas
APAmapá
BABahia
CECeará
DFDistrito federal
ESEspírito Santo
GOGoiás
MAMaranhão
MGMinas Gerais
MSMato Grosso do Sul
MTMato Grosso
PAPará
PBParaíba
PEPernambuco
PIPiauí
PRParaná
RJRio de Janeiro
RNRio Grande do Norte
RORondônia
RRRoraima
RSRio Grande do Sul
SCSanta Catarina
SESergipe
SPSão Paulo
TOTocantins
EXExceção

Response​

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

Response Body Params​

CampoTipoDescriçãoCaracteres
occurrence_key *uuidv4Chave única de identificação da ocorrência (instrução) no formato uuid v436
bank_slip_key *uuidv4Chave única de identificação do boleto no formato uuid v436

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
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'.