Skip to main content

Fee management

Request​

ENDPOINT
/baas/billing/ACCOUNT_KEY/billing_configuration
METHOD
PUT
Definition and Transfer of Fees

The maximum values for each fee must be aligned with the QI Tech commercial team. The amount to be transferred to the partner, referring to each fee charged, must also be aligned with the QI Tech commercial team.

General Observations:

For this endpoint, it is important that the "Request Body" is followed strictly as all fields are mandatory.

Request Body
{
   "billing_configuration_data": {
      "bankslip": {
         "bankslip_fees": {
            "registration": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "permanence": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "protest_removal": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "protest_request": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "protest_costs": {
               "amount": 100,
               "expense_type": "percentage"
            },
            "expiration_date_change": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "rebate_inclusion": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "discount_inclusion": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "notary_office_payment": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "expiration_write_off": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "write_off": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "protest_write_off": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "protest_removal_and_write_off": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "payment": {
               "amount": 10,
               "expense_type": "absolute_value"
            },
            "fine_or_interest_inclusion": {
               "amount": 10,
               "expense_type": "absolute_value"
            }
         },
         "billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "ted": {
         "ted_fees": {
            "outgoing_ted": {
               "amount": 20,
               "expense_type": "absolute_value"
            },
            "incoming_ted": {
               "amount": 20,
               "expense_type": "absolute_value"
            }
         },
         "billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "pix": {
         "pix_fees": {
            "incoming_pix_manual": {
               "amount": 2,
               "expense_type": "absolute_value"
            },
            "outgoing_pix_manual": {
               "amount": 2,
               "expense_type": "absolute_value"
            },
            "incoming_pix_key": {
               "amount": 3,
               "expense_type": "absolute_value"
            },
            "outgoing_pix_key": {
               "amount": 3,
               "expense_type": "absolute_value"
            },
            "incoming_pix_static_qr_code": { 
               "amount": 3,
               "expense_type": "absolute_value"
            },
            "outgoing_pix_static_qr_code": {
               "amount": 3,
               "expense_type": "absolute_value"
            },
            "incoming_pix_dynamic_qr_code": {
               "amount": 3,
               "expense_type": "absolute_value"
            },
            "outgoing_pix_dynamic_qr_code": {
               "amount": 3,
               "expense_type":"absolute_value"
            }
         },
         "billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "account_maintenance": {
         "amount": 500,
         "billing_account_key": "f6bc82ae-8ede-424d-9450-242a8c9d2435"
      }
   }
}

BODY PARAMS​

FieldTypeDescription
billing_configuration_dataobjectbilling_configuration_data

Billing_configuration_data​

FieldTypeDescription
bankslipobjectBankslip
tedobjectTED
pixobjectPix
account_maintenanceobjectAccount maintenance

Bankslip​

FieldTypeDescription
bankslip_feesobjectBankslip_fees
billing_account_keystringid (uuid) containing the reference to the account to which the fee will be charged

Bankslip_fees​

FieldTypeDescriptionReference
registrationobjectRegistration feeStandard fees object
permanenceobjectPermanence fee for registered titleStandard fees object
protest_removalobjectProtest removal/negative removal feeStandard fees object
protest_requestobjectProtest/negative inclusion feeStandard fees object
protest_costsobjectProtest costs, for this field expense_type must be 'percentage'Standard fees object
expiration_date_changeobjectExpiration date change feeStandard fees object
rebate_inclusionobjectRebate inclusion feeStandard fees object
discount_inclusionobjectDiscount inclusion feeStandard fees object
notary_office_paymentobjectFee for title settled at notary officeStandard fees object
expiration_write_offobjectFee for title written off due to elapsed timeStandard fees object
write_offobjectFee for title written off on requestStandard fees object
protest_write_offobjectFee for protested title written offStandard fees object
protest_removal_and_write_offobjectFee for title written off with protest removal/notary returnStandard fees object
paymentobjectSettlement feeStandard fees object
fine_or_interest_inclusionobjectFee for inclusion of fines and interestStandard fees object

Ted​

FieldTypeDescription
ted_feesobjectTed_fees
billing_account_keystringid (uuid) containing the reference to the account to which the fee will be charged

Ted_fees​

FieldTypeDescription
outgoing_tedobjectstandard-fees-object
incoming_tedobjectstandard-fees-object

Pix​

FieldTypeDescription
pix_feesobjectPix_fees
billing_account_keystringid (uuid) containing the reference to the account to which the fee will be charged

Pix_fees​

FieldTypeDescription
incoming_pix_manualobjectStandard fees object
outgoing_pix_manualobjectStandard fees object
incoming_pix_keyobjectStandard fees object
outgoing_pix_keyobjectStandard fees object
incoming_pix_static_qr_codeobjectStandard fees object
outgoing_pix_static_qr_codeobjectStandard fees object
incoming_pix_dynamic_qr_codeobjectStandard fees object
outgoing_pix_dynamic_qr_codeobjectStandard fees object

Account_maintenance​

FieldTypeDescription
amountnumberFee amount which can represent either an absolute value (absolute_value) or a percentage (percentage), limited to two decimal places
billing_account_keystringid (uuid) containing the reference to the account to which the fee will be charged

Standard-fees-object​

FieldTypeDescriptionReference
amountnumberFee amount which can represent either an absolute value (absolute_value) or percentage (percentage), limited to two decimal places
expense_typeenumFee formatEnumerators expense_type

Enumerators

Enumerator Expense Type​

EnumeratorDescription
percentageValue in percentage
absolute_valueAbsolute value

Response​

STATUS
200
Response Body
{
   "billing_configuration_data":{
      "bankslip":{
         "bankslip_fees":{
            "registration":{
               "amount":10,
               "expense_type":"absolute_value"
            },
            "permanence":{
               "amount":10,
               "expense_type":"absolute_value"
            },
            "protest_removal":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "protest_request":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "protest_costs":{
               "amount":20,
               "expense_type":"percentage"
            },
            "expiration_date_change":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "rebate_inclusion":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "discount_inclusion":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "notary_office_payment":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "expiration_write_off":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "write_off":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "protest_write_off":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "protest_removal_and_write_off":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "payment":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "fine_or_interest_inclusion":{
               "amount":20,
               "expense_type":"absolute_value"
            }
         },
         "billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "ted":{
         "ted_fees":{
            "outgoing_ted":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "incoming_ted":{
               "amount":20,
               "expense_type":"absolute_value"
            }
         },
         "billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "pix":{
         "pix_fees":{
            "incoming_pix_manual":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "outgoing_pix_manual":{
               "amount":20,
               "expense_type":"absolute_value"
            },
            "incoming_pix_key":{
               "amount":30,
               "expense_type":"absolute_value"
            },
            "outgoing_pix_key":{
               "amount":30,
               "expense_type":"absolute_value"
            },
            "incoming_pix_static_qr_code":{
               "amount":30,
               "expense_type":"absolute_value"
            },
            "outgoing_pix_static_qr_code":{
               "amount":30,
               "expense_type":"absolute_value"
            },
            "incoming_pix_dynamic_qr_code":{
               "amount":30,
               "expense_type":"absolute_value"
            },
            "outgoing_pix_dynamic_qr_code":{
               "amount":30,
               "expense_type":"absolute_value"
            }
         },
         "billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
      },
      "account_maintenance":{
         "amount":40,
         "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\"}"
}