编辑

编辑指令用于在票据发行后修改其可配置的数据，例如自动核销设置、抗议设置、破产抗议设置和付款人数据。该指令允许在单次请求中更新票据的多个方面。

注意！

票据必须处于 registered 状态才能进行编辑。请求中除 request_control_key 外，至少必须提供一个数据字段（write_off_data、protest_data、bankruptcy_protest_data 或 payer_data）。

Request

ENDPOINT

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

MÉTODO

POST

Path parameters

字段	类型	描述	字符数
`account_key`	uuidv4	账户唯一标识键，uuid v4 格式	36
`requester_profile_key`	uuidv4	钱包唯一标识键，uuid v4 格式	36
`bank_slip_key`	uuidv4	票据唯一标识键，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

字段	类型	描述	字符数
`request_control_key` *	uuidv4	客户使用的请求唯一标识键，uuid v4 格式	36
`write_off_data`	object	自动核销设置（null 表示移除）	Objeto write_off_data
`protest_data`	object	抗议设置（null 表示移除）	Objeto protest_data
`bankruptcy_protest_data`	object	破产抗议设置（null 表示移除）	Objeto bankruptcy_protest_data
`payer_data`	object	付款人数据（`address` 为 null 或 `contact` 为 null 表示移除对应字段）	Objeto payer_data

说明

请求中至少必须提供一个数据字段（write_off_data、protest_data、bankruptcy_protest_data 或 payer_data）。

Objeto write_off_data

字段	类型	描述	字符数
`days_to_write_off` *	integer	到期后自动核销票据的天数	-

Objeto protest_data

字段	类型	描述	字符数
`days_to_protest` *	integer	到期后自动抗议票据的天数	-

Objeto bankruptcy_protest_data

字段	类型	描述	字符数
`days_to_bankruptcy_protest` *	integer	到期后自动启动破产抗议流程的天数	-

Objeto payer_data

字段	类型	描述	字符数
`contact`	object	联系信息	Objeto contact
`address`	object	地址	Objeto address

Objeto contact

字段	类型	描述	字符数
`email`	string	联系电子邮件	320
`phone`	object	联系电话	Objeto phone

Objeto phone

字段	类型	描述	字符数
`international_dial_code` *	string	国际区号（DDI）	3
`area_code` *	string	地区区号（DDD）	2
`number` *	string	补充号码	9

Objeto address

字段	类型	描述	字符数
`street` *	string	街道	500
`number` *	string	门牌号	6
`complement`	string	补充信息	500
`neighborhood` *	string	社区/街区	100
`postal_code` *	string	邮政编码	8
`city` *	string	城市	100
`state` *	string	州（UF）	Enumerador state

Enumeradores state

枚举值	描述
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

字段	类型	描述	字符数
`occurrence_key` *	uuidv4	记录（指令）唯一标识键，uuid v4 格式	36
`bank_slip_key` *	uuidv4	票据唯一标识键，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": {}
}

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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'.

Request​

Path parameters​

Request Body Params​

Objeto write_off_data​

Objeto protest_data​

Objeto bankruptcy_protest_data​

Objeto payer_data​

Objeto contact​

Objeto phone​

Objeto address​

Enumeradores state​

Response​

Response Body Params​

Error Response​