注册新限额
要注册新限额,只需向以下端点发送一个 Account 类型的对象:
POST https://api.caas.qitech.app/limits_pix/account
示例
{
"account_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
"registration_date": "2019-12-20T15:23:12",
"limit": {
"withdraw": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"change": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"transaction_natural_person": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"transaction_legal_person": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
}
}
}
所有注册信息交换都使用以下对象定义。在某些情况下,为了方便实现并减少双方之间的数据流,某些信息可能会被省略。
| 名称 | 类型 | 描述 |
|---|---|---|
| account_id | string | 账户唯一标识符。 对于每个请求,此编号必须是唯一的 |
| registration_date | string (ISO 8601) | 注册日期和时间。 |
| limit | limit | limit 类型的对象。 |
Limit 对象
{
"withdraw": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"change": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"transaction_natural_person": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"transaction_legal_person": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
}
}
此对象表示适用于不同类型交易在一天中不同时间段的金额限制,考虑到日间和夜间时段的划分。
该对象分为四个主要类别(或限额类型):"withdraw"(指 PIX 取款模式)、"change"(指 PIX 找零模式)、"transaction_natural_person"(指个人 PIX 交易模式)和 "transaction_legal_person"(指企业 PIX 交易模式)。每个类别包含 2 个时段,"daytime" 和 "nighttime",分别代表日间和夜间时段,描述开始时间和要应用于该模式的相应金额限制。值得注意的是,limit 对象的 4 个 PIX 类别是必填的,在创建账户时必须存在。
限额窗口结构:
| 名称 | 类型 | 描述 |
|---|---|---|
| start_time | string (ISO 8601) | 指示 PIX 交易金额限制开始应用的时刻。请注意根据您打算使用的时区正确配置限额窗口的开始时间。 |
| amount | 整数 | 以巴西雷亚尔分(centavos)为单位,在 "start_time" 指定的时段内对该模式允许的最大限额值。 |
使用示例: 假设用户在 12:00:00-03:00 进行个人 PIX 交易。查询对象时,我们找到 "transaction_natural_person" 类别。在该类别中,我们找到 2 个时段,"daytime" 和 "nighttime":第一个从 "06:00:00-03:00" 开始,第二个从 "20:00:00-03:00" 开始。如果交易在这些时间之间进行,则允许的最大金额为 5,000.00(五千)巴西雷亚尔,如第一个限额窗口所规定。
但是,如果交易在 "20:00:00-03:00" 之后且在下一个开始时间之前(在此示例中,为次日 06:00),则允许的最大金额将为 3,000.00(三千)巴西雷亚尔,如第二个限额窗口(夜间窗口)所示。
创建限额修改提案
要请求修改限额,只需向以下端点发送一个 Limit 类型的对象:
POST https://api.caas.qitech.app/limits_pix/account/{account_id}/limit_update_request
示例
{
"withdraw": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
},
"change": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 550000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 350000
}
},
"transaction_natural_person": {
"daytime" : {
"start_time": "06:00:00-03:00",
"amount": 500000
},
"nighttime" : {
"start_time": "20:00:00-03:00",
"amount": 300000
}
}
}
请求的返回将由所有已进行的修改列表组成,按时段和 PIX 限额类别分隔。在上面的示例中,修改在 "change"(PIX 找零)类别中进行,请求增加两个时段的 限额。因此,请求的响应如下:
{ "limit_update_requests" : [
{
"limit_update_request_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
"analysis_status": "automatically_approved",
"client_notification_status": "not_applicable",
"limit_update_request_status": "applied",
"limit_update_request_type" : "change_daytime",
"event_date": "2019-10-01T10:37:25-03:00"
},
{
"limit_update_request_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
"analysis_status": "automatically_approved",
"client_notification_status": "not_applicable",
"limit_update_request_status": "applied",
"limit_update_request_type" : "change_nighttime",
"event_date": "2019-10-01T10:37:25-03:00"
},
]
}
| 名称 | 类型 | 描述 |
|---|---|---|
| limit_update_request_id | string | 限额修改提案的唯一标识符 |
| analysis_status | string | 提案的 analysis_status 枚举值 |
| client_notification_status | string | 提案的 client_notification_status 枚举值 |
| limit_update_request_status | string | 提案的 limit_update_request_status 枚举值 |
| limit_update_request_type | string | 提案的 limit_update_request_type 枚举值 |
| event_date | string (ISO 8601) | 限额修改提案的创建日期和时间 |
要更好地了解返回状态,请访问状态动态。