Desconto

A instrução de desconto serve para aplicar descontos com diversas possibilidades de regras de cálculo. Caso já existam descontos para o boleto em questão, e seja aceita uma instrução de desconto, os descontos existentes previamente serão sobrescritos.

Atenção!

Caso exista algum pedido de acréscimo de desconto pendente de confirmação, não é permitida a criação de um novo pedido.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/discount

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": "2e2f0053-a988-40c7-ad17-41c4c4da861e",
    "discounts_data": [
        {
            "discount_type": "anticipation_workdays_daily_percentage",
            "discount_percentage": 2,
            "discount_number": 1,
            "discount_limit_date": "2024-12-01"
        },
        {
            "discount_type": "anticipation_workdays_daily_percentage",
            "discount_percentage": 1,
            "discount_number": 2,
            "discount_limit_date": "2025-01-02"
        }
    ]
}

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
discounts_data	object array	Descontos	Objeto discount

Objeto discount

Opção 1: descontos utilizando valores absolutos (discount_type in ["absolute", "anticipation_calendar_days_daily_amount", "anticipation_workdays_daily_amount"])

Campo	Tipo	Descrição	Caracteres
discount_amount *	float	Valor absoluto de desconto por unidade de tempo	-
discount_number *	integer	Número do desconto	-
discount_type *	string	Configuração do desconto em valores absolutos	Enumerador discount_type
discount_limit_date *	string	Data limite para aplicação do desconto	10

Opção 2: descontos utilizando valores percentuais (discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"])

Campo	Tipo	Descrição	Caracteres
discount_percentage *	float	Valor percentual de desconto por unidade de tempo	-
discount_number *	integer	Número do desconto	-
discount_type *	string	Configuração do desconto em valores percentuais	Enumerador discount_type
discount_limit_date *	string	Data limite para aplicação do desconto	10

Atenção!

O boleto pode ter até três descontos, sendo que os descontos devem ser todos do mesmo tipo, isto é, devem ter o mesmo discount_type. Os descontos devem ser numerados de 1 a 3, de maneira crescente e começando necessariamente em 1. Ou seja, caso sejam enviados dois descontos na requisição, devem necessariamente ser numerados com 1 e 2.

Enumeradores discount_type

Enumerador	Descrição
absolute	Valor fixo
anticipation_calendar_days_daily_amount	Valor diário de desconto de antecipação, sobre dias corridos
anticipation_workdays_daily_amount	Valor diário de desconto de antecipação, sobre dias úteis
percentage	Porcentagem fixa
anticipation_calendar_days_daily_percentage	Porcentagem mensal de desconto de antecipação, com base em dias corridos
anticipation_workdays_daily_percentage	Porcentagem anual de desconto de antecipação, com base em dias úteis

Response

STATUS

202

Response Body

{
  "occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
  "bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}

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	BKS000018	Bad Request	The discount dates must be less than the expiration date and increasing.	A data dos descontos devem ser menores que a de expiração e crescentes.
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'.
400	BKS000043	Bad Request	Invalid discount numbering. Discounts must be numbered in ascending order and start on 1.	Numeração dos descontos inválida. Os descontos devem ser numerados em ordem crescente e começar em 1.
400	BKS000046	Bad Request	Invalid discount type. All types in the discount list must be the same.	Tipo de desconto inválido. Todos os tipos da lista de descontos devem ser iguais.
409	BKS000048	Conflict	There is already a pending discount occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.	Já existe uma ocorrência de desconto pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.