Skip to main content

Fields

amount : Int! required

Amount set up as collateral as condition for account creation.

collateralType : SettableCollateralType

The kind of collateral that satisfies the requirement. A requirement naming no kind records what is required and has nothing set up for it.

interestPolicy : String

Type of interest policy of required collateral.

reason : String! required

Reason for setting up required collateral.

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": 35, "collateralType": "SECURITY_DEPOSIT", "description": "sort-of-then-summer-few", "displayName": "professor-speak-happen-claim-environment", "identifier": "27188403", "interestPolicy": "future-significant-she-woman-must", "isVariable": true, "reason": "program-child-sing-dark-large", "type": "produce-deal-seem-last-cut" }