跳到主要内容

获取转让批次

获取特定转让批次的完整详情，包括转让配置、当前状态、事件历史、放款数据和金额。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView Assignments
转让方assignor-api读取

各主机的 Base URL：环境（主机）。

适用场景

在流程的任何时刻都可以使用该端点查询批次的当前状态——例如确认批次是否已通过合格性审查、是否已审批通过或是否已付款。当创建返回重复（TRC000041）时，也应使用此查询。

Request​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}
MÉTODO
GET

Path params​

参数类型描述
fund_class_keystring基金的唯一 key（UUID）。
assignment_configuration_keystring转让配置的 key（UUID）。
assignment_external_idstring创建批次时提供的 external_id。

Response​

STATUS
200
Response Body
Response Body
{
  "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
  "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
  "name": "CESSÃO #12345",
  "assignment_configuration": {
    "assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
    "validation_configuration_key": "5f0e3a4c-2b7d-4c1e-9a8f-0d6b1c2e3f40",
    "assignment_configuration_name": "Config CCB Fundo Alpha",
    "assignment_contract_key": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "registry_type": "internal_registry",
    "asset_type": "ccb",
    "fund_class": {
      "fund_class_key": "f1a2b3c4-d5e6-4890-abcd-ef1234567890",
      "name": "Fundo Alpha FIDC",
      "document_number": "11.222.333/0001-81",
      "accounting_date": "2024-04-01",
      "manager": {
        "manager_key": "e1f2a3b4-c5d6-4890-abcd-ef1234567890",
        "document_number": "22.222.222/0001-91",
        "manager_name": "Gestora Exemplo S.A."
      }
    },
    "assignor": {
      "assignor_key": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
      "document_number": "33.333.333/0001-91",
      "name": "Cedente Exemplo Ltda"
    },
    "assignment_reports": {
      "send_reports": false
    },
    "assignment_configuration_type": "default_configuration",
    "status": "active",
    "consultant_decision_type": "manual_approval",
    "manager_decision_type": "manual_approval",
    "asset_fees": null,
    "payment_type": "pix",
    "custody_type": "internal",
    "required_documents": ["ccb"],
    "after_assignment_required_documents": [],
    "certifier": "certifiqi",
    "disbursement_account_policy": "all_assignor_accounts",
    "consultant": {
      "consultant_key": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",
      "document_number": "44.444.444/0001-91",
      "name": "Consultoria Exemplo Ltda"
    },
    "operation_type": "unsecured_credit",
    "originator_bonds": [
      {
        "originator": {
          "originator_key": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
          "document_number": "33.333.333/0001-91",
          "name": "Cedente Exemplo Ltda"
        }
      }
    ]
  },
  "assignment_number": "12345",
  "assignment_date": "2024-04-01",
  "status": "completed",
  "assignment_term_key": "b1c2d3e4-f5a6-4890-abcd-ef1234567890",
  "disbursement": {
    "target_account": {
      "account_key": "d1e2f3a4-b5c6-4890-abcd-ef1234567890",
      "account_type": "checking_account",
      "account_branch": "0001",
      "account_number": "12345",
      "account_digit": "4",
      "financial_institution_code": "341",
      "financial_institution_ispb": "60701190",
      "owner": {
        "document_number": "33.333.333/0001-91"
      },
      "payment_type": "pix"
    }
  },
  "origin_type": "client",
  "payment_type": "pix",
  "assignment_total_value": 150000.00,
  "assignment_irr": 0.0215,
  "status_events": [
    {
      "status": "pending_assets_insertion",
      "event_datetime": "2024-04-01 10:00:00.123456",
      "selected_agent": {
        "AGENT-TYPE": "assignor",
        "AGENT-KEY": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
        "AGENT-USER": "usuario@exemplo.com"
      }
    },
    {
      "status": "completed_assets_insertion",
      "event_datetime": "2024-04-01 11:30:00.654321"
    },
    {
      "status": "completed",
      "event_datetime": "2024-04-01 16:00:00.000000"
    }
  ]
}

响应属性​

字段类型描述
assignment_keystringQI Tech 生成的批次唯一标识（UUID）。
external_idstring合作伙伴在创建时提供的外部 key。
namestring转让的标识名称。
assignment_numberstring转让批次编号。
assignment_datestring转让日期，格式为 YYYY-MM-DD。
statusstring批次当前状态。参见批次状态。
origin_typestring批次来源。通过集成 API 创建的批次为 client。
payment_typestring | null向转让方付款的方式：pix 或 wire_transfer。取自批次；批次中未提供时取自转让配置。
assignment_term_keystring | null转让协议书的 key（UUID）。协议书生成后填充。
assignment_total_valuenumber转让总额，以雷亚尔为单位。在首次计算（于结束插入时进行）之前不返回。
assignment_irrnumber批次的内部收益率。尚未计算时不返回。
assignment_configurationobject批次的转让配置。字段说明参见转让配置列表。
disbursementobject | null批次的放款账户，位于 target_account 中，包含账户字段及所用的 payment_type。尚未确定时为 null。
assignor_discountsarray对转让方的扣减项。仅当批次有扣减时返回。见下表。
status_eventsarray批次的状态转换历史。见下表。

assignor_discounts 属性​

字段类型描述
assignor_discount_keystring扣减项的唯一 key（UUID）。
assignor_discount_typestringexpense_reimbursement 或 others。
statusstringcreated、pending_execution、executed 或 rejected。
total_valuenumber扣减金额，以雷亚尔为单位。
descriptionstring扣减描述。

status_events 属性​

字段类型描述
statusstring批次转入的状态。
event_datetimestring状态转换的日期和时间，UTC，格式为 YYYY-MM-DD HH:MM:SS.ffffff。
selected_agentobject执行该转换的代理方（AGENT-TYPE、AGENT-KEY 和 AGENT-USER）。自动转换时不返回。
denial_reasonstring在 denied 和 discarded 中返回：拒绝或废弃的来源（eligibility、registry、accounting_close、payment、manager、asset_documents、manual、consultant 或 inconsistency）。
denial_metadataobject拒绝的详细信息（如有）——例如未通过的合格性规则，或在审批时发送的 denial_reason。

错误​

状态码代码触发条件
404TRC000016fund_class_key 与 assignment_configuration_key 的组合不对应任何转让配置。
404TRC000018该转让配置中没有使用此 external_id 的批次。

认证、权限和主机相关错误：参见 API 错误。