Gestão de tarifas
Request
ENDPOINT
/account/ACCOUNT_KEY/billing_configurationMÉTODO
PUTDefinição e Repasse de Tarifas
Os valores máximos e mínimos de cada tarifa devem ser alinhados com o time comercial da QI Tech.
O valor a ser repassado ao parceiro, referente a cada tarifa cobrada, também deve ser alinhado junto ao time comercial da QI Tech.
Observações Gerais:
Para este endpoint, é importante que o "Request Body" seja seguido a risca visto que todos os campos são de carater obrigatório.
Request Body
{
"billing_configuration_data":{
"bank_slip":{
"registration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":10,
"expense_type":"fixed_amount"
},
"bank_slip_instant_registration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"permanence":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":10,
"expense_type":"fixed_amount"
},
"protest_removal":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_request":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_costs":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"percentage"
},
"expiration_date_change":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"rebate_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"discount_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"notary_office_payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"expiration_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_removal_and_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment_qr_code":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"fine_or_interest_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_fine_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_interest_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_discount_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
},
"ted":{
"outgoing_ted":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount",
},
"incoming_ted":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
}
},
"pix":{
"incoming_pix":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"outgoing_pix":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
},
"account": {
"account_maintenance":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"incoming_funds":{
"amount":10,
"expense_type": "percentage",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"account_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
},
"qr_code": {
"dynamic_qr_code_expiration":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
},
"prepaid_card": {
"prepaid_fisical_card_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"prepaid_virtual_card_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"card_withdrawal_fee":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"international_card_withdrawal_fee":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
}
}
}
BODY PARAMS
| Campo | Tipo | Descrição |
|---|---|---|
billing_configuration_data | object | Billing_configuration_data |
Billing_configuration_data
| Campo | Tipo | Descrição |
|---|---|---|
bank_slip | object | Bankslip |
ted | object | TED |
pix | object | Pix |
account | object | Conta |
prepaid_card | object | Conta |
qr_code | object | Conta |
BankSlip
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
registration | object | Tarifa de registro | Objeto padrão fees |
permanence | object | Tarifa de permanência título cadastrado | Objeto padrão fees |
protest_removal | object | Tarifa de sustação/Excl Negativação | Objeto padrão fees |
protest_request | object | Tarifa de protesto/Incl Negativação | Objeto padrão fees |
protest_costs | object | Custas de Protestos, para esse campo expense_type deve ser 'percentage' | Objeto padrão fees |
expiration_date_change | object | Tarifa alteração de vencimento | Objeto padrão fees |
rebate_inclusion | object | Tarifa concessão abatimento | Objeto padrão fees |
discount_inclusion | object | Tarifa concessão desconto | Objeto padrão fees |
notary_office_payment | object | Tarifa título Baix. Pg. Cartório | Objeto padrão fees |
expiration_write_off | object | Tarifa título baixado decurso prazo | Objeto padrão fees |
write_off | object | Tarifa título baixado conf. Pedido | Objeto padrão fees |
protest_write_off | object | Tarifa título baixado protestado | Objeto padrão fees |
protest_removal_and_write_off | object | Tarifa título baixado SUST/RET/CARTÓRIO | Objeto padrão fees |
payment | object | Tarifa Liquidação | Objeto padrão fees |
payment_qr_code | object | Tarifa Liquidação por QR-Code | Objeto padrão fees |
fine_or_interest_inclusion | object | Tarifa de inclusão de Multa e Juros | Objeto padrão fees |
bank_slip_fine_alteration | object | Tarifa de alteração de Multa | Objeto padrão fees |
bank_slip_interest_alteration | object | Tarifa de alteração de Juros | Objeto padrão fees |
bank_slip_discount_alteration | object | Tarifa de alteração de Desconto | Objeto padrão fees |
bank_slip_instant_registration | object | Tarifa de registro de boleto instantâneo | Objeto padrão fees |
Ted
| Campo | Tipo | Descrição | Referência
|---|---|---|
| outgoing_ted | object | Tarifa de Envio de TED | Objeto padrão fees |
| incoming_ted | object | Tarifa de Entrada de TED | Objeto padrão fees |
Pix
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
incoming_pix | object | Tarifa de Entrada de Pix | Objeto padrão fees |
outgoing_pix | object | Tarifa de Envio de Pix | Objeto padrão fees |
Account
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
incoming_funds | object | Tarifa de Entrada de Recurso | Objeto padrão fees |
account_maintenance | object | Tarifa de Manutenção de Conta | Objeto padrão fees |
account_creation | object | Tarifa de Criação de Conta | Objeto padrão fees |
QrCode
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
dynamic_qr_code_expiration | object | Tarifa de Expiração de QR-Code Dinâmico não Liquidado | Objeto padrão fees |
PrepaidCard
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
prepaid_fisical_card_creation | object | Tarifa de Criação de Cartão Físico | Objeto padrão fees |
prepaid_virtual_card_creation | object | Tarifa de Criação de Cartão Virtual | Objeto padrão fees |
card_withdrawal_fee | object | Tarifa de Saque | Objeto padrão fees |
international_card_withdrawal_fee | object | Tarifa de Saque Internacional | Objeto padrão fees |
Objeto padrão fees
| Campo | Tipo | Descrição | Referência |
|---|---|---|---|
amount | number | Valor da taxa a qual poderá representar em valor absoluto (fixed_amount) ou porcentagem (percentage), deve ser limitado a duas casas decimais | |
expense_type | enum | Formato de cobrança | Enumerador expense_type |
billing_account_key | string | id (uuid) contendo a referência para a conta a qual será cobrada a taxa |
Enumeradores
Enumerador Expense Type
| Enumerador | Descrição |
|---|---|
| percentage | Valor em porcentagem |
| fixed_amount | Valor absoluto |
Response
STATUS
200Response Body
{
"account_key": "3a4fe5f9-3133-4ce3-9988-9ff8827bcaa5",
"billing_configuration_data":{
"bank_slip":{
"registration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":10,
"expense_type":"fixed_amount"
},
"bank_slip_instant_registration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"permanence":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":10,
"expense_type":"fixed_amount"
},
"protest_removal":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_request":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_costs":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"percentage"
},
"expiration_date_change":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"rebate_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"discount_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"notary_office_payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"expiration_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"protest_removal_and_write_off":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment_qr_code":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"payment":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"fine_or_interest_inclusion":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_fine_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_interest_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"bank_slip_discount_alteration":{
"billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
},
"ted":{
"outgoing_ted":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount",
},
"incoming_ted":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
}
},
"pix":{
"incoming_pix":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
"outgoing_pix":{
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435",
"amount":20,
"expense_type":"fixed_amount"
},
},
"account": {
"account_maintenance":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"incoming_funds":{
"amount":10,
"expense_type": "percentage",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"account_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
},
"qr_code": {
"dynamic_qr_code_expiration":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
},
"prepaid_card": {
"prepaid_fisical_card_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"prepaid_virtual_card_creation":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"card_withdrawal_fee":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"international_card_withdrawal_fee":{
"amount":40,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
}
}
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}