费率管理
Request
ENDPOINT
/account/ACCOUNT_KEY/billing_configurationMÉTODO
PUT费率定义与转让
每项费率的最大值和最小值必须与 QI Tech 商务团队协商确定。
向合作伙伴转让的金额（对应每项收取的费率）也必须与 QI Tech 商务团队协商确定。
一般注意事项：
对于此端点，"Request Body" 必须严格按照要求填写，因为所有字段均为必填项。
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"
},
"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_transfer":{
"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"
}
},
"automatic_pix": {
"active_recurrence": {
"amount":0.50,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
},
"recurrence_settlement": {
"amount":0.80,
"expense_type": "fixed_amount",
"billing_account_key":"f6bc82ae-8ede-424d-9450-242a8c9d2435"
}
}
}
}
请求体参数
| 字段 | 类型 | 描述 |
|---|---|---|
billing_configuration_data | object | 计费配置数据 |
计费配置数据
| 字段 | 类型 | 描述 |
|---|---|---|
bank_slip | object | 银行票据 |
ted | object | TED |
pix_transfer | object | Pix |
account | object | 账户 |
prepaid_card | object | 预付卡 |
qr_code | object | QR 码 |
automatic_pix | object | 自动 PIX |
银行票据（BankSlip）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
registration | object | 登记费 | 标准费率对象 |
permanence | object | 已登记票据保留费 | 标准费率对象 |
protest_removal | object | 撤销抗议/移除负面记录费 | 标准费率对象 |
protest_request | object | 抗议申请/添加负面记录费 | 标准费率对象 |
protest_costs | object | 抗议费用，此字段的 expense_type 必须为 'percentage' | 标准费率对象 |
expiration_date_change | object | 更改到期日费 | 标准费率对象 |
rebate_inclusion | object | 添加折扣费 | 标准费率对象 |
discount_inclusion | object | 添加优惠费 | 标准费率对象 |
notary_office_payment | object | 公证处付款票据撤销费 | 标准费率对象 |
expiration_write_off | object | 逾期撤销票据费 | 标准费率对象 |
write_off | object | 按请求撤销票据费 | 标准费率对象 |
protest_write_off | object | 撤销抗议票据费 | 标准费率对象 |
protest_removal_and_write_off | object | 撤销票据 SUST/RET/公证处费 | 标准费率对象 |
payment | object | 结算费 | 标准费率对象 |
payment_qr_code | object | QR 码结算费 | 标准费率对象 |
fine_or_interest_inclusion | object | 添加罚款和利息费 | 标准费率对象 |
bank_slip_fine_alteration | object | 修改罚款费 | 标准费率对象 |
bank_slip_interest_alteration | object | 修改利息费 | 标准费率对象 |
bank_slip_discount_alteration | object | 修改折扣费 | 标准费率对象 |
bank_slip_instant_registration | object | 即时银行票据登记费 | 标准费率对象 |
TED
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
outgoing_ted | object | TED 发送费 | 标准费率对象 |
incoming_ted | object | TED 接收费 | 标准费率对象 |
Pix
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
incoming_pix | object | PIX 接收费 | 标准费率对象 |
outgoing_pix | object | PIX 发送费 | 标准费率对象 |
账户（Account）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
incoming_funds | object | 资金进账费 | 标准费率对象 |
account_maintenance | object | 账户维护费 | 标准费率对象 |
account_creation | object | 开户费 | 标准费率对象 |
QR 码（QrCode）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
dynamic_qr_code_expiration | object | 未结清动态 QR 码到期费 | 标准费率对象 |
预付卡（PrepaidCard）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
prepaid_fisical_card_creation | object | 实体卡创建费 | 标准费率对象 |
prepaid_virtual_card_creation | object | 虚拟卡创建费 | 标准费率对象 |
card_withdrawal_fee | object | 取款费 | 标准费率对象 |
international_card_withdrawal_fee | object | 国际取款费 | 标准费率对象 |
自动 PIX（Pix Automático）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
active_recurrence | object | PIX 有效循环费 | 标准费率对象 |
recurrence_settlement | object | PIX 循环结算费 | 标准费率对象 |
标准费率对象（fees）
| 字段 | 类型 | 描述 | 参考 |
|---|---|---|---|
amount | number | 费率金额，可以是绝对值（fixed_amount）或百分比（percentage），限两位小数 | |
expense_type | enum | 收费方式 | expense_type 枚举值 |
billing_account_key | string | 包含收费账户引用的 id（uuid） |
枚举值
expense_type 枚举值
| 枚举值 | 描述 |
|---|---|
| percentage | 百分比金额 |
| fixed_amount | 绝对金额 |
Response
STATUS
200Response Body
{
"account_key": "3a4fe5f9-3133-4ce3-9988-9ff8827bcaa5",
"billing_configuration_data":{
"bank_slip":{...},
"ted":{...},
"pix":{...},
"account": {...},
"qr_code": {...},
"prepaid_card": {...},
"automatic_pix": {...}
}
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}