Get assignment fund

Returns one fund registration by identifier; 404 when the validated tenant has none with that identifier.

GET /api/v1/assignment/funds/{fundId}

Get assignment fund

cURL

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/funds/{fundId} \
  --header 'Authorization: Bearer <token>'

200

{
  "administratorName": "<string>",
  "administratorTaxId": "<string>",
  "assignmentRate": "<string>",
  "assignorConcentrationLimit": "<string>",
  "borrowerConcentrationLimit": "<string>",
  "createdAt": "<string>",
  "eligibilityMode": "<string>",
  "excludeOverdue": true,
  "excludeSuspendedRegistration": true,
  "fundName": "<string>",
  "fundTaxId": "<string>",
  "id": "<string>",
  "offerFileLayoutRef": "<string>",
  "offerSentToRemessaReceivedWindowSeconds": 123,
  "paidToTransferredWindowSeconds": 123,
  "paymentSourceConcentrationLimit": "<string>",
  "paymentTolerance": "<string>",
  "proposedRetainedFraction": "<string>",
  "proposedRiskRetention": "<string>",
  "proposesSellerRetainsControl": true,
  "registryProvider": "<string>",
  "repeatedCutLimit": 123,
  "termMode": "<string>",
  "transferredToAcceptedWindowSeconds": 123,
  "updatedAt": "<string>"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

fundId · string<uuid> · obrigatório

Fund registration identifier.

Resposta

200

application/json

OK

administratorName · string · obrigatório

Fund administrator name.

administratorTaxId · string · obrigatório

Fund administrator registration identifier.

assignmentRate · string · obrigatório

Monthly effective cession rate as a decimal fraction string, scale 8 (e.g. "0.01750000").

assignorConcentrationLimit · string | null · obrigatório

Concentration limit per assignor, as a decimal fraction string, scale 8. Null when the fund registered none: no per-assignor limit applies.

borrowerConcentrationLimit · string | null · obrigatório

Concentration limit per debtor, as a decimal fraction string, scale 8. Null when the fund registered none: no per-debtor limit applies.

createdAt · string · obrigatório

Creation timestamp (RFC3339, UTC).

eligibilityMode · string · obrigatório

full (our verification is authoritative), prefilter (the administrator verifies; the same engine runs ahead of the offer file) or none (the client checks eligibility at the fund; only the ledger's integrity rules and a registered repeatedCutLimit run here).

excludeOverdue · boolean · obrigatório

Whether a receivable carrying an open arrear is cut. False when the fund registered no arrear policy.

excludeSuspendedRegistration · boolean · obrigatório

Whether a receivable whose registration is suspended at the rail is cut, at scoring and at approval. False when the fund registered no such policy.

fundName · string · obrigatório

Fund name.

fundTaxId · string · obrigatório

Fund registration identifier; the natural key of the registration within a tenant.

id · string · obrigatório

Fund registration identifier (uuid). Stable across configuration changes.

offerFileLayoutRef · string · obrigatório

The custodian export layout: lerian-offer-v0, or reporter: naming a Reporter template UUID in its canonical lowercase form.

offerSentToRemessaReceivedWindowSeconds · integer<int64> · obrigatório

Orphan-detector window for "offer sent without return file", in seconds.

paidToTransferredWindowSeconds · integer<int64> · obrigatório

Orphan-detector window for "paid without transferred", in seconds.

paymentSourceConcentrationLimit · string | null · obrigatório

Concentration limit per payment source, as a decimal fraction string, scale 8 (e.g. "0.15000000"). Null when the fund registered none: no per-payment-source limit applies.

paymentTolerance · string · obrigatório

How far what the fund pays for a lot may sit from the frozen prices of its paid lines before the acceptance is held, decimal string, scale 2. Frozen on each lot at assembly.

proposedRetainedFraction · string · obrigatório

The retained fraction (share of the expected loss kept after the sale, 0 to 1) this fund PROPOSES for the cessions assembled against it, decimal string, scale 8. Only a proposal: each cession freezes its own fraction at assembly, so re-declaring the fund never re-classifies a sale already composed.

proposedRiskRetention · string · obrigatório

PROPOSED, not frozen: the regime a cession taking this fund's proposal would derive against the institution's CURRENT threshold. substantial when proposedRetainedFraction is at or above it (such a cession is refused today, LENDER-0504), none below it. A composed cession's regime is on the set and never read from here.

proposesSellerRetainsControl · boolean · obrigatório

Whether this fund PROPOSES that the seller keeps control of what it sells (Res. CMN 4.966 art. 26 III). Only a proposal; a cession that ends up with true is refused (LENDER-0505).

registryProvider · string · obrigatório

Which registry governs this fund's cession. none means no registry governs it; any other value is a registry declared by one of this deployment's jurisdictions.

repeatedCutLimit · integer<int64> | null · obrigatório

How many times this fund may cut the same receivable before it stops returning to the pool automatically. Null when the fund registered no brake: a cut receivable always returns to the pool.

termMode · string · obrigatório

Who produces the endorsement term. administrator_generated (the usual case): the administrator and the fund sign it outside the Lender; payment opens at the fund's return file and never waits for the term, and a signed PDF the operator receives may be recorded as optional evidence. lender_emitted: the Lender emits it from the fund's published template, and payment waits for it.

transferredToAcceptedWindowSeconds · integer<int64> · obrigatório

Orphan-detector window for "transferred without accepted", in seconds.

updatedAt · string · obrigatório

Last-update timestamp (RFC3339, UTC).