Register or update an assignment fund

Creates or replaces the registration of one fund and its administrator, keyed by fundTaxId within the validated tenant. Identifier and creation instant of an existing registration are preserved, so this is the update path as well as the create path.

POST /api/v1/assignment/funds

Register or update an assignment fund

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/funds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "administratorName": "<string>",
  "administratorTaxId": "<string>",
  "assignmentRate": "0.0175",
  "assignorConcentrationLimit": "0.30",
  "fundName": "<string>",
  "fundTaxId": "<string>",
  "offerFileLayoutRef": "custodian-cnab240.v1",
  "paidToTransferredWindowSeconds": 172800,
  "paymentSourceConcentrationLimit": "0.15",
  "proposedRetainedFraction": "0",
  "proposesSellerRetainsControl": false,
  "registryProvider": "none",
  "transferredToAcceptedWindowSeconds": 86400,
  "repeatedCutLimit": 2
}
'

200

{
  "administratorName": "<string>",
  "administratorTaxId": "<string>",
  "assignmentRate": "<string>",
  "assignorConcentrationLimit": "<string>",
  "createdAt": "<string>",
  "eligibilityMode": "<string>",
  "fundName": "<string>",
  "fundTaxId": "<string>",
  "id": "<string>",
  "offerFileLayoutRef": "<string>",
  "paidToTransferredWindowSeconds": 123,
  "paymentSourceConcentrationLimit": "<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.

Corpo

application/json

administratorName · string · obrigatório

Fund administrator name.

Required string length: 1 - 256

administratorTaxId · string · obrigatório

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

Required string length: 1 - 64

assignmentRate · string · obrigatório

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.

Exemplo:

"0.0175"

assignorConcentrationLimit · string · obrigatório

Regulation concentration limit per assignor as a decimal fraction string in (0, 1] with at most 8 decimals.

Exemplo:

"0.30"

eligibilityMode · enum<string> · obrigatório

Whether our eligibility verification is authoritative (full) or runs as a pre-filter before the administrator's own (prefilter).

Opções disponíveis: full, prefilter

fundName · string · obrigatório

Fund name.

Required string length: 1 - 256

fundTaxId · string · obrigatório

Fund registration identifier. Re-posting the same value REPLACES that fund's configuration and keeps its identifier. 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 · obrigatório

Versioned reference to the custodian export layout. Letters, digits and -_.: only.

Required string length: 1 - 128

Exemplo:

"custodian-cnab240.v1"

paidToTransferredWindowSeconds · integer<int64> · obrigatório

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

Intervalo obrigatório: 1 <= x <= 31536000

Exemplo:

172800

paymentSourceConcentrationLimit · string · obrigatório

Regulation concentration limit per payment source as a decimal fraction string in (0, 1] with at most 8 decimals (e.g. "0.15").

Exemplo:

"0.15"

proposedRetainedFraction · string · obrigatório

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.

Exemplo:

"0"

proposesSellerRetainsControl · boolean · obrigatório

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).

Exemplo:

false

registryProvider · string · obrigatório

Which registry governs this fund's cession. REQUIRED, and none must be stated rather than omitted: this call REPLACES the stored registration, so a save that stayed silent would turn a fund whose acceptance is fenced by a confirmed title movement into one that is not. none means registration at a registry is dispensable for this fund and its absence never blocks a cession. Any other value must be a registry one of this deployment's jurisdictions declares — deliberately NOT an enum here, because the set is open per jurisdiction and a fixed list would pin the contract to one country. A value nobody declared is refused, and the refusal names what is declared.

Exemplo:

"none"

termMode · enum<string> · obrigatório

Who generates the endorsement term.

Opções disponíveis: lender_emitted, administrator_generated

transferredToAcceptedWindowSeconds · integer<int64> · obrigatório

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

Intervalo obrigatório: 1 <= x <= 31536000

Exemplo:

86400

repeatedCutLimit · integer<int64>

How many times this fund may cut the same receivable in its remessa before the receivable stops returning to the pool automatically. Omit to take the default of 2.

Intervalo obrigatório: x >= 1

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 · obrigatório

Regulation concentration limit per assignor, as a decimal fraction string, scale 8.

createdAt · string · obrigatório

Creation timestamp (RFC3339, UTC).

eligibilityMode · string · obrigatório

full (our verification is authoritative) or prefilter (the administrator verifies; the same engine runs ahead of the offer file).

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

Versioned reference to the custodian export layout.

paidToTransferredWindowSeconds · integer<int64> · obrigatório

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

paymentSourceConcentrationLimit · string · obrigatório

Regulation concentration limit per payment source, as a decimal fraction string, scale 8 (e.g. "0.15000000").

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> · obrigatório

How many times this fund may cut the same receivable before it stops returning to the pool automatically.

termMode · string · obrigatório

Who generates the endorsement term: lender_emitted or administrator_generated.

transferredToAcceptedWindowSeconds · integer<int64> · obrigatório

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

updatedAt · string · obrigatório

Last-update timestamp (RFC3339, UTC).