Pular para o conteúdo principal

Valor

A instrução de valor permite alterar o valor de um boleto, desde que o boleto já tenha sido registrado. Caso já exista uma instrução de valor pendente de confirmação para o boleto em questão, não é permitido o envio de uma nova instrução.

Atenção!

Caso exista alguma instrução de valor pendente de confirmação, não é permitido o envio de uma nova instrução.

Request

ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/amount
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": "01234567-89ab-cdef-0123-456789abcdef",
"amount": 150.50
}

Request Body Params

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v436
amount *numberNovo valor do boleto (deve ser diferente do valor atual)-
Atenção!

O valor deve ser diferente do valor atual do boleto e deve ter no máximo 2 casas decimais.

Response

STATUS
202
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'.
409BKS000135ConflictAn amount occurrence already exists for this bank slip.Já existe uma ocorrência de valor para este boleto.
400BKS000136Bad RequestOnly credit card financial instrument type can have zero amount.Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.
400BKS000137Bad RequestAmount must be different from bank slip amount.O valor deve ser diferente do valor do boleto.