Skip to main content

Input fields

amount : Int! required

Amount set up as collateral as condition for account creation.

collateralType : SettableCollateralType

The kind of collateral that satisfies the requirement. Naming one sets the collateral up when the contract is actualized, and fixes the requirement: it cannot be varied afterwards.

isVariable : Boolean

Whether the term is variable.

reason : CollateralRequiredReason! required

Reason for setting up required collateral.

reasonDescription : String

The reason spelled out. Required when the reason is OTHER, otherwise omit.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "amount": 40, "collateralType": "SECURITY_DEPOSIT", "isVariable": true, "reason": "INSUFFICIENT_CREDIT_HISTORY", "reasonDescription": "knowledge-car-avoid-often-put" }