金额

金额指令允许修改已登记票据的金额。若票据存在待确认的金额指令，则不允许发送新的指令。

注意！

若存在待确认的金额指令，则不允许发送新的指令。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/amount

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": "01234567-89ab-cdef-0123-456789abcdef",
    "amount": 150.50
}

Request Body Params

字段	类型	描述	字符数
`request_control_key` *	uuidv4	客户使用的请求唯一标识键，uuid v4 格式	36
`amount` *	number	票据新金额（必须与当前金额不同）	-

注意！

金额必须与票据当前金额不同，且最多保留 2 位小数。

Response

STATUS

202

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'.
409	BKS000135	Conflict	An amount occurrence already exists for this bank slip.	Já existe uma ocorrência de valor para este boleto.
400	BKS000136	Bad Request	Only credit card financial instrument type can have zero amount.	Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.
400	BKS000137	Bad Request	Amount must be different from bank slip amount.	O valor deve ser diferente do valor do boleto.

Request​

Path parameters​

Request Body Params​

Response​

Response Body Params​

Error Response​