Pular para o conteúdo principal

Envio e Remoção de Garantia na Operação

Este conjunto de endpoints permite a adição e remoção de garantias associadas a uma operação. O collateral é um mecanismo de adição de garantias à operação e será submetido para assinatura junto com os documentos da operação.


Envio de Garantia (POST)

Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/collateral
MÉTODO
POST

Path Params

CampoTipoDescriçãoCaracteres Máx.
OPERATION-KEY *stringChave única da operação (UUID v4).36

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

Request Body Params

CampoTipoDescriçãoObrigatório
collateral_document_base64 *stringConteúdo do documento do collateral codificado em Base64.Sim
collateral_type *stringTipo do collateral.Enumeradores collateral_type
collateral_data *objectEstrutura de metadados relacionados ao collateral.Sim

Response

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

Response Body Params

CampoTipoDescriçãoCaracteres Máx.
collateral_key *stringChave única do collateral adicionado (UUID v4).36
collateral_type *stringTipo do collateral.Enumeradores collateral_type
collateral_data *objectEstrutura de metadados relacionados ao collateral.-

Remoção de Collateral (DELETE)

Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/collateral/COLLATERAL-KEY
MÉTODO
DELETE

Path Params

CampoTipoDescriçãoCaracteres Máx.
OPERATION-KEY *stringChave única da operação (UUID v4).36
COLLATERAL-KEY *stringChave única do collateral a ser removido (UUID v4).36

Response

STATUS
204

Nenhum conteúdo é retornado no corpo da resposta.

Enumeradores collateral_type

EnumDescrição
contractContrato de garantia.