Saltar al contenido principal
POST
Register or update an assignment fund

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
administratorName
string
requerido

Fund administrator name.

Required string length: 1 - 256
administratorTaxId
string
requerido

Fund administrator registration identifier (opaque; no jurisdiction format is assumed).

Required string length: 1 - 64
assignmentRate
string
requerido

Monthly effective cession rate as a decimal fraction string in [0, 1] with at most 8 decimals (0.0175 = 1.75% per month). Zero means assignment at par.

Ejemplo:

"0.0175"

assignorConcentrationLimit
string | null
requerido

Concentration limit per assignor as a decimal fraction string in (0, 1] with at most 8 decimals. REQUIRED and nullable, as borrowerConcentrationLimit: null registers none.

Ejemplo:

"0.30"

borrowerConcentrationLimit
string | null
requerido

Concentration limit per debtor as a decimal fraction string in (0, 1] with at most 8 decimals. REQUIRED and nullable: this call REPLACES the stored registration, so null must be stated to register none, and an omitted field is refused rather than read as an erased limit. With none, a lot of one receivable can sell; a registered limit has no exemption for a lone exposure.

Ejemplo:

"0.20"

eligibilityMode
enum<string>
requerido

Whether our eligibility verification is authoritative (full), runs as a pre-filter before the administrator's own (prefilter), or is left to the client, who checks eligibility at the fund (none). Under none the limits and policies below are kept but not applied, except repeatedCutLimit; the ledger's own integrity rules run in every mode.

Opciones disponibles:
full,
prefilter,
none
excludeOverdue
boolean
requerido

Whether a receivable carrying an open arrear is cut. REQUIRED: this call REPLACES the stored registration. false when the fund buys arrears.

Ejemplo:

true

excludeSuspendedRegistration
boolean
requerido

Whether a receivable whose registration is suspended at the rail is cut, at scoring and at approval. REQUIRED: this call REPLACES the stored registration. false when the fund buys suspended registrations.

Ejemplo:

false

fundName
string
requerido

Fund name.

Required string length: 1 - 256
fundTaxId
string
requerido

Fund registration identifier. Re-posting the same value REPLACES that fund's configuration and keeps its identifier. A replacement governs the next set assembled: a set already assembled keeps the term mode, eligibility mode, limits, policies and windows it froze. Bounded at 32 bytes because this is the one value carried into the fixed-width offer file, which refuses rather than truncates.

Required string length: 1 - 32
offerFileLayoutRef
string
requerido

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

Required string length: 1 - 128
Ejemplo:

"lerian-offer-v0"

offerSentToRemessaReceivedWindowSeconds
integer<int64>
requerido

How long the fund may take to return its file after the offer was sent, in whole seconds. The fund always returns one, with a verdict for every receivable of the set, so a set still at offer_sent past this window opens an offer_sent_without_remessa case for the operator.

Rango requerido: 1 <= x <= 31536000
Ejemplo:

172800

paidToTransferredWindowSeconds
integer<int64>
requerido

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

Rango requerido: 1 <= x <= 31536000
Ejemplo:

172800

paymentSourceConcentrationLimit
string | null
requerido

Concentration limit per payment source as a decimal fraction string in (0, 1] with at most 8 decimals (e.g. "0.15"). REQUIRED and nullable, as borrowerConcentrationLimit: null registers none.

Ejemplo:

"0.15"

proposedRetainedFraction
string
requerido

The retained fraction this fund PROPOSES for the cessions assembled against it: the share of the expected loss this institution keeps after the sale, a decimal string from 0 to 1 with at most 8 decimal places (0 keeps nothing). REQUIRED and never inferred: this call REPLACES the stored registration. A cession may state its own fraction and freezes whichever it ends up with, next to the institution's threshold; a fraction at or above the threshold derives substantial retention, which a cession cannot be booked under yet (LENDER-0504). Not a decimal, below 0, above 1 or more than 8 decimal places: LENDER-0506.

Ejemplo:

"0"

proposesSellerRetainsControl
boolean
requerido

Whether this fund PROPOSES that the seller keeps control of what it sells, the middle band of Res. CMN 4.966 art. 26 III. REQUIRED. A cession may state its own; one that ends up with true is refused (LENDER-0505).

Ejemplo:

false

registryProvider
string
requerido

Which registry governs this fund's cession. REQUIRED, and only none is accepted: the Lender today registers no cession at a registry, the institution registers each contract in its own flow. Any other value is refused, and the refusal names the accepted values. A fund stored on a registry earlier still reads back with it, and no set is assembled over it until it is saved with none.

Ejemplo:

"none"

repeatedCutLimit
integer<int64> | null
requerido

How many times this fund may cut the same receivable in its remessa before the receivable stops returning to the pool automatically, at least 1. REQUIRED and nullable: null registers no brake, and a cut receivable then always returns to the pool. It applies in every eligibility mode.

Rango requerido: x >= 1
termMode
enum<string>
requerido

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. Each set freezes the mode at assembly, so a change governs the next set.

Opciones disponibles:
lender_emitted,
administrator_generated
transferredToAcceptedWindowSeconds
integer<int64>
requerido

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

Rango requerido: 1 <= x <= 31536000
Ejemplo:

86400

paymentTolerance
string

How far what the fund pays for a lot may sit from the frozen prices of its paid lines, above or below, before a fund_payment_divergence case opens and the acceptance is held: a decimal string, zero or more, at most 2 decimal places. Omitted means 0.00, exact to the centavo; this call REPLACES the stored registration, so a save that omits it resets it. Each lot freezes the tolerance at assembly.

Ejemplo:

"0.00"

Respuesta

OK

administratorName
string
requerido

Fund administrator name.

administratorTaxId
string
requerido

Fund administrator registration identifier.

assignmentRate
string
requerido

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

assignorConcentrationLimit
string | null
requerido

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
requerido

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

createdAt
string
requerido

Creation timestamp (RFC3339, UTC).

eligibilityMode
string
requerido

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
requerido

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

excludeSuspendedRegistration
boolean
requerido

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
requerido

Fund name.

fundTaxId
string
requerido

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

id
string
requerido

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

offerFileLayoutRef
string
requerido

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

offerSentToRemessaReceivedWindowSeconds
integer<int64>
requerido

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

paidToTransferredWindowSeconds
integer<int64>
requerido

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

paymentSourceConcentrationLimit
string | null
requerido

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
requerido

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
requerido

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
requerido

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
requerido

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
requerido

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
requerido

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
requerido

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>
requerido

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

updatedAt
string
requerido

Last-update timestamp (RFC3339, UTC).