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

Field	Type	Description
`billing_configuration_data`	object	billing_configuration_data

Billing_configuration_data

Field	Type	Description
`bankslip`	object	Bankslip
`ted`	object	TED
`pix`	object	Pix
`account_maintenance`	object	Account maintenance

Bankslip

Field	Type	Description
`bankslip_fees`	object	Bankslip_fees
`billing_account_key`	string	id (uuid) containing the reference to the account to which the fee will be charged

Bankslip_fees

Field	Type	Description	Reference
`registration`	object	Registration fee	Standard fees object
`permanence`	object	Permanence fee for registered title	Standard fees object
`protest_removal`	object	Protest removal/negative removal fee	Standard fees object
`protest_request`	object	Protest/negative inclusion fee	Standard fees object
`protest_costs`	object	Protest costs, for this field expense_type must be 'percentage'	Standard fees object
`expiration_date_change`	object	Expiration date change fee	Standard fees object
`rebate_inclusion`	object	Rebate inclusion fee	Standard fees object
`discount_inclusion`	object	Discount inclusion fee	Standard fees object
`notary_office_payment`	object	Fee for title settled at notary office	Standard fees object
`expiration_write_off`	object	Fee for title written off due to elapsed time	Standard fees object
`write_off`	object	Fee for title written off on request	Standard fees object
`protest_write_off`	object	Fee for protested title written off	Standard fees object
`protest_removal_and_write_off`	object	Fee for title written off with protest removal/notary return	Standard fees object
`payment`	object	Settlement fee	Standard fees object
`fine_or_interest_inclusion`	object	Fee for inclusion of fines and interest	Standard fees object

Ted

Field	Type	Description
`ted_fees`	object	Ted_fees
`billing_account_key`	string	id (uuid) containing the reference to the account to which the fee will be charged

Ted_fees

Field	Type	Description
`outgoing_ted`	object	standard-fees-object
`incoming_ted`	object	standard-fees-object

Pix

Field	Type	Description
`pix_fees`	object	Pix_fees
`billing_account_key`	string	id (uuid) containing the reference to the account to which the fee will be charged

Pix_fees

Field	Type	Description
`incoming_pix_manual`	object	Standard fees object
`outgoing_pix_manual`	object	Standard fees object
`incoming_pix_key`	object	Standard fees object
`outgoing_pix_key`	object	Standard fees object
`incoming_pix_static_qr_code`	object	Standard fees object
`outgoing_pix_static_qr_code`	object	Standard fees object
`incoming_pix_dynamic_qr_code`	object	Standard fees object
`outgoing_pix_dynamic_qr_code`	object	Standard fees object

Account_maintenance

Field	Type	Description
`amount`	number	Fee amount which can represent either an absolute value (absolute_value) or a percentage (percentage), limited to two decimal places
`billing_account_key`	string	id (uuid) containing the reference to the account to which the fee will be charged

Standard-fees-object

Field	Type	Description	Reference
`amount`	number	Fee amount which can represent either an absolute value (absolute_value) or percentage (percentage), limited to two decimal places
`expense_type`	enum	Fee format	Enumerators expense_type

Enumerators

Enumerator Expense Type

Enumerator	Description
percentage	Value in percentage
absolute_value	Absolute 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\"}"
}

Fee management

Request​

BODY PARAMS​

Billing_configuration_data​

Bankslip​

Bankslip_fees​

Ted​

Ted_fees​

Pix​

Pix_fees​

Account_maintenance​

Standard-fees-object​