跳到主要内容

创建受益人列表

根据巴西中央银行的 PIX 限额规定，可以创建一个将使用相同差异化限额的受益人列表。

要请求为账户创建受益人列表，只需向以下端点发送一个 Limit 类型的对象：

POST https://api.caas.qitech.app/limits_pix/account/{account_id}/recipient_list

{
    "limit" : {
        "transaction": {
            "daytime" : {
                "start_time": "06:00:00-03:00",
                "amount": 60000
            },
            "nighttime" : {
                "start_time": "20:00:00-03:00",
                "amount": 60000 
            }
        }
    }
}

将返回以下内容：

{
    "event_date": "2019-10-01T10:37:25-03:00"
}
名称类型描述
event_datestring (ISO 8601)受益人列表的创建日期和时间

向受益人列表添加新受益人

要向之前创建的受益人列表添加新受益人，只需执行以下请求：

POST https://api.caas.qitech.app/limits_pix/account/{account_id}/recipient_list/recipient

{
    "document_number": "123.456.789-10"
}

将返回以下内容：

{
    "recipient_id": "c7a79970-b558-4425-998a-5cd6747c1c90",
    "analysis_status": "automatically_approved",
    "client_notification_status": "awaiting_notification_period",
    "recipient_status": "created",
    "event_date": "2019-10-01T10:37:25-03:00"
}
名称类型描述
recipient_idstring此限额修改提案中受益人的唯一标识符
analysis_statusstring提案的 analysis_status 枚举值
client_notification_statusstring提案的 client_notification_status 枚举值
recipient_statusstring提案的 recipient_status 枚举值
event_datestring (ISO 8601)限额修改提案的创建日期和时间

要更好地了解返回状态，请访问状态动态。

删除受益人

要删除账户的特定受益人，只需向以下地址发送 DELETE 类型的请求：

DELETE https://api.caas.qitech.app/limits_pix/account/{account_id}/recipient_list/recipient/{recipient_id}

编辑受益人列表的限额

要请求更改给定账户的受益人限额，只需执行以下请求：

POST https://api.caas.qitech.app/limits_pix/account/{account_id}/recipient_list/limit_update_request

{
    "limit" : {
        "transaction": {
            "daytime" : {
                "start_time": "06:00:00-03:00",
                "amount": 70000
            },
            "nighttime" : {
                "start_time": "20:00:00-03:00",
                "amount": 70000 
            }
        }
    }
}

请求的返回将由所有已进行的修改列表组成，按时段分隔。在上面的示例中，修改在 "transaction" 类别中进行，请求增加两个时段的限额。因此，请求的响应如下：

{   "recipient_list_limit_update_requests" : [
        { 
            "limit_update_request_id": "c7a79970-b558-4425-998a-5cd6747c1c90",
            "analysis_status": "automatically_approved",
            "client_notification_status": "awaiting_notification_period",
            "recipient_status": "created",
            "recipient_list_limit_update_request_type" : "transaction_daytime",
            "event_date": "2019-10-01T10:37:25-03:00"
        },
        { 
            "limit_update_request_id": "c7a79970-b558-4425-998a-5cd6747c1c90",
            "analysis_status": "automatically_approved",
            "client_notification_status": "awaiting_notification_period",
            "recipient_status": "created",
            "recipient_list_limit_update_request_type" : "transaction_nighttime",
            "event_date": "2019-10-01T10:37:25-03:00"
        },
    ]
}
名称类型描述
recipient_idstring此限额修改提案中受益人的唯一标识符
analysis_statusstring提案的 analysis_status 枚举值
client_notification_statusstring提案的 client_notification_status 枚举值
recipient_statusstring提案的 recipient_status 枚举值
recipient_list_limit_update_request_typestring提案的 recipient_list_limit_update_request_type 枚举值
event_datestring (ISO 8601)限额修改提案的创建日期和时间