Skip to main content
POST
Assemble an assignment set

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
fundId
string<uuid>
required

Fund registration this composition is offered to. Its cession rate prices every receivable and its regulation supplies the concentration limits.

receivableRefs
string[] | null
required

The receivables the desk chose, by rail contract reference. A reference the tenant's assignable pool does not carry is refused by name — never dropped from the set silently.

Required array length: 1 - 500 elements
retainedFraction
string

The share of the expected loss this institution keeps after THIS sale, a decimal string from 0 to 1 with at most 8 decimal places (0 keeps nothing, 0.1 keeps 10%). Omit it to take the fraction the fund proposes. Whichever results is frozen onto the cession next to the institution's substantial-retention threshold of that day, and the regime is derived from those two frozen values, never re-read from the fund. Refusals: null or blank LENDER-0503; not a decimal, below 0, above 1 or more than 8 decimal places LENDER-0506; a fraction at or above the threshold (substantial retention) LENDER-0504, not bookable yet.

Example:

"0"

sellerRetainsControl
boolean

Whether the seller keeps control of what THIS sale transfers, the middle band of Res. CMN 4.966 art. 26 III that a fraction cannot express. Omit it to take what the fund proposes. Refusals: null LENDER-0503; true LENDER-0505, a band this product does not book and never will.

Example:

false

Response

Created

items
object[] | null
required

Every receivable ever admitted to this set, survivors and departures alike, in the order the composition was read. Always present, empty slice when none.

set
object
required

The set and the aggregates of its surviving composition.

approval
object

The immutable approval fact. Absent while the composition has not been approved.