跳到主要内容

创建债权转让

债权转让 API 允许客户直接创建和查询债权转让。可以使用债权转让配置密钥（UUID4）创建债权转让，并通过特定端点查询债权转让的一般信息。

注意

此服务仅对已注册债权转让配置的合作伙伴开放，请咨询我们的支持团队了解详情。

创建债权转让​

要创建债权转让，需要使用客户的配置密钥（assignment_configuration_key）、参与本次债权转让的信贷操作密钥集合（credit_operation_keys）以及daily_assignment_interest_rate（即每日债权转让利率，该利率与相关合同采用相同的天数基准）向端点发起 POST 请求。

Request​

ENDPOINT
/v2/assignment/assignment_configuration/[assignment_configuration_key]/assignment
MÉTODO
POST

Params​

字段描述
assignment_configuration_key客户债权转让配置的标识密钥
Request Body
{
  "credit_operation_keys": ["key1", "key2", "key3"],
  "daily_assignment_interest_rate": 0.0003
}
注意

如果在 Request 中未为特定合同提供 daily_assignment_interest_rate，则将使用客户债权转让配置中注册的转让利率。

Response​

STATUS
201
Response Body
[
  {
  "assignment_key": "868a2951-efff-4e41-8adf-bc36871a20fb",
  "creation_datetime": "2023-10-01T12:00:00",
  "reference_date": "2023-10-01",
  "total_amount": 120000,
  "number_of_items": 3,
  "status": "pending_items_calculation",
  "created_at": "2023-10-01T11:00:00"
  }
]

查询债权转让​

要查询特定债权转让，客户可以使用债权转让标识密钥（assignment_key）向端点发起 GET 请求。

Request​

ENDPOINT
/v2/assignment/[assignment_key]
MÉTODO
GET

Params​

字段描述
assignment_key债权转让标识密钥

Response​

STATUS
200
Response Body
{
  "assignment_key": "77997168-5d61-430f-b5ae-08eb3d7b8c0e",
  "creation_datetime": "2023-10-01T12:00:00",
  "reference_date": "2023-10-01",
  "total_amount": 120000,
  "number_of_items": 5,
  "term_of_assignment_url": "https://example.com/assignment.pdf",
  "status": "settled",
  "signable_term_url": "https://example.com/signable_term.pdf"
}

查询债权转让项目​

要查询债权转让中的合同，请使用相同的 assignment_key 向端点发起 GET 请求。

Request​

ENDPOINT
/v2/assignment/[assignment_key]/assignment_items
MÉTODO
GET

Params​

字段描述
assignment_key债权转让标识密钥

Response​

返回结果为债权转让中每份合同的信息列表（状态码 200），已分页：

Response​

STATUS
200
Response Body
{
    "data": [
        {
            "assignment_item_key": "439b1257-82ac-4741-a416-a4428a9a7327",
            "control_number": "0001",
            "credit_operation_key": "d7f2ba40-30ea-4462-890c-6a99a7d85659",
            "issuer_name": "João Santos",
            "issuer_document_number": "12345678912",
            "issue_amount": 50000,
            "disbursed_amount": 45000,
            "disbursement_date": "2023-01-01",
            "number_of_installments": 12,
            "contract_number": "XXX182938",
            "present_amount": 48000,
            "status": "settled",
            "endorsement_url": "https://example.com/endorsement.pdf",
            "purchaser_document_number": "1234567890001"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 10
    }
}