Skip to main content
POST
Register or update an assignment fund

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
administratorName
string
required

Fund administrator name.

Required string length: 1 - 256
administratorTaxId
string
required

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

Required string length: 1 - 64
assignmentRate
string
required

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.

Example:

"0.0175"

assignorConcentrationLimit
string
required

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

Example:

"0.30"

eligibilityMode
enum<string>
required

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

Available options:
full,
prefilter
fundName
string
required

Fund name.

Required string length: 1 - 256
fundTaxId
string
required

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
required

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

Required string length: 1 - 128
Example:

"custodian-cnab240.v1"

paidToTransferredWindowSeconds
integer<int64>
required

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

Required range: 1 <= x <= 31536000
Example:

172800

paymentSourceConcentrationLimit
string
required

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

Example:

"0.15"

registryProvider
string
required

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.

Example:

"none"

riskRetention
string
required

Whether assigning to this fund leaves substantial risk with the assignor (Res. CMN 4.966). REQUIRED, and the only accepted value is none — assignment transferring substantially all risks and rewards, which is what this service books: the receivable is derecognized and the gain or loss recognized on the sale date. Assignment WITH retained risk keeps the asset on the balance sheet, turns the price into a liability and appropriates the result over the remaining term; that treatment does not exist yet and any other value is refused rather than approximated. Deliberately NOT an enum here, so the refusal can say what is missing instead of reading as a malformed field.

Example:

"none"

termMode
enum<string>
required

Who generates the endorsement term.

Available options:
lender_emitted,
administrator_generated
transferredToAcceptedWindowSeconds
integer<int64>
required

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

Required range: 1 <= x <= 31536000
Example:

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.

Required range: x >= 1

Response

OK

administratorName
string
required

Fund administrator name.

administratorTaxId
string
required

Fund administrator registration identifier.

assignmentRate
string
required

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

assignorConcentrationLimit
string
required

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

createdAt
string
required

Creation timestamp (RFC3339, UTC).

eligibilityMode
string
required

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

fundName
string
required

Fund name.

fundTaxId
string
required

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

id
string
required

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

offerFileLayoutRef
string
required

Versioned reference to the custodian export layout.

paidToTransferredWindowSeconds
integer<int64>
required

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

paymentSourceConcentrationLimit
string
required

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

registryProvider
string
required

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

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

riskRetention
string
required

Whether assigning to this fund leaves substantial risk with the assignor (Res. CMN 4.966). Always none today: the receivable is derecognized and the result recognized on the sale date.

termMode
string
required

Who generates the endorsement term: lender_emitted or administrator_generated.

transferredToAcceptedWindowSeconds
integer<int64>
required

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

updatedAt
string
required

Last-update timestamp (RFC3339, UTC).