Pular para o conteúdo principal

Gestão de tarifas

Request

ENDPOINT
/account/ACCOUNT_KEY/billing_configuration
MÉTODO
PUT
Definiçã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

CampoTipoDescrição
billing_configuration_dataobjectBilling_configuration_data

Billing_configuration_data

CampoTipoDescrição
bank_slipobjectBankslip
tedobjectTED
pixobjectPix
accountobjectConta
prepaid_cardobjectConta
qr_codeobjectConta

BankSlip

CampoTipoDescriçãoReferência
registrationobjectTarifa de registroObjeto padrão fees
permanenceobjectTarifa de permanência título cadastradoObjeto padrão fees
protest_removalobjectTarifa de sustação/Excl NegativaçãoObjeto padrão fees
protest_requestobjectTarifa de protesto/Incl NegativaçãoObjeto padrão fees
protest_costsobjectCustas de Protestos, para esse campo expense_type deve ser 'percentage'Objeto padrão fees
expiration_date_changeobjectTarifa alteração de vencimentoObjeto padrão fees
rebate_inclusionobjectTarifa concessão abatimentoObjeto padrão fees
discount_inclusionobjectTarifa concessão descontoObjeto padrão fees
notary_office_paymentobjectTarifa título Baix. Pg. CartórioObjeto padrão fees
expiration_write_offobjectTarifa título baixado decurso prazoObjeto padrão fees
write_offobjectTarifa título baixado conf. PedidoObjeto padrão fees
protest_write_offobjectTarifa título baixado protestadoObjeto padrão fees
protest_removal_and_write_offobjectTarifa título baixado SUST/RET/CARTÓRIOObjeto padrão fees
paymentobjectTarifa LiquidaçãoObjeto padrão fees
payment_qr_codeobjectTarifa Liquidação por QR-CodeObjeto padrão fees
fine_or_interest_inclusionobjectTarifa de inclusão de Multa e JurosObjeto padrão fees
bank_slip_fine_alterationobjectTarifa de alteração de MultaObjeto padrão fees
bank_slip_interest_alterationobjectTarifa de alteração de JurosObjeto padrão fees
bank_slip_discount_alterationobjectTarifa de alteração de DescontoObjeto padrão fees
bank_slip_instant_registrationobjectTarifa de registro de boleto instantâneoObjeto 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

CampoTipoDescriçãoReferência
incoming_pixobjectTarifa de Entrada de PixObjeto padrão fees
outgoing_pixobjectTarifa de Envio de PixObjeto padrão fees

Account

CampoTipoDescriçãoReferência
incoming_fundsobjectTarifa de Entrada de RecursoObjeto padrão fees
account_maintenanceobjectTarifa de Manutenção de ContaObjeto padrão fees
account_creationobjectTarifa de Criação de ContaObjeto padrão fees

QrCode

CampoTipoDescriçãoReferência
dynamic_qr_code_expirationobjectTarifa de Expiração de QR-Code Dinâmico não LiquidadoObjeto padrão fees

PrepaidCard

CampoTipoDescriçãoReferência
prepaid_fisical_card_creationobjectTarifa de Criação de Cartão FísicoObjeto padrão fees
prepaid_virtual_card_creationobjectTarifa de Criação de Cartão VirtualObjeto padrão fees
card_withdrawal_feeobjectTarifa de SaqueObjeto padrão fees
international_card_withdrawal_feeobjectTarifa de Saque InternacionalObjeto padrão fees

Objeto padrão fees

CampoTipoDescriçãoReferência
amountnumberValor da taxa a qual poderá representar em valor absoluto (fixed_amount) ou porcentagem (percentage), deve ser limitado a duas casas decimais
expense_typeenumFormato de cobrançaEnumerador expense_type
billing_account_keystringid (uuid) contendo a referência para a conta a qual será cobrada a taxa

Enumeradores

Enumerador Expense Type

EnumeradorDescrição
percentageValor em porcentagem
fixed_amountValor absoluto

Response

STATUS
200
Response 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
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}