Operation Collateral Submission and Removal

This set of endpoints allows adding and removing guarantees associated with an operation. Collateral is a mechanism for adding guarantees to the operation and will be submitted for signature along with the operation documents.

---

Collateral Submission (POST)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/collateral

METHOD

POST

Path Params

Field	Type	Description	Max Characters
OPERATION-KEY *	string	Unique operation key (UUID v4).	36

---

Request Body

{
  "collateral_document_base64": "sringb64",
  "collateral_type": "contract",
  "collateral_data": {}
}

Request Body Params

Field	Type	Description	Required
collateral_document_base64 *	string	Collateral document content encoded in Base64.	Yes
collateral_type *	string	Collateral type.	collateral_type enumerators
collateral_data *	object	Structure of metadata related to the collateral.	Yes

Response

STATUS

201

Response Body

{
  "collateral_key": "25dd10b8-7364-4abe-b0e8-0e419b04194b",
  "collateral_type": "contract",
  "collateral_data": {}
}

Response Body Params

Field	Type	Description	Max Characters
collateral_key *	string	Unique key of the added collateral (UUID v4).	36
collateral_type *	string	Collateral type.	collateral_type enumerators
collateral_data *	object	Structure of metadata related to the collateral.	-

---

Collateral Removal (DELETE)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/collateral/COLLATERAL-KEY

METHOD

DELETE

Path Params

Field	Type	Description	Max Characters
OPERATION-KEY *	string	Unique operation key (UUID v4).	36
COLLATERAL-KEY *	string	Unique key of the collateral to be removed (UUID v4).	36

Response

STATUS

204

No content is returned in the response body.

collateral_type enumerators

Enum	Description
contract	Guarantee contract.