Removal

O que é o removal na prática?

O removal trata-se de um patch de alteração de contrato. Com ele, as especificações desejadas serão removidas, mas o contrato permanecerá ativo.

Exemplo:

Qual a diferença entre Removal e Cancelamento?

• No cancelamento, o contrato deixa de estar ativo e todas as especificações deste contrato serão removidas das URs
• Já no removal, somente as especificações desejadas serão removidas e o contrato permanecerá ativo

📘

Mas e se todas as especificações de um contrato forem solicitadas no Removal?

Neste contexto, o contrato permanecerá ativo mas não afetará nenhuma posição. Para este caso, recomenda-se que seja realizada a operação de cancelamento.

Como é o payload a ser enviado?

O payload deve ser enviado pela API conforme exemplo abaixo.

Exemplo:

{
	"contracts": [
		{
			"key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
			"contractSpecifications": [
				{
					"effectValue": "1000000",
					"paymentScheme": "VCC",
					"receivableDebtor": "AAAAAAAAAAAAA",
					"originalAssetHolder": "YYYYYYYYYYYYYYY",
					"expectedSettlementDate": "2023-01-27",
					"originalAssetHolderDocumentType": "CNPJ",
					"EffectEvent": "Removal"
				}
			]
		}
	]
}

Detalhamento dos campos:

• “key” = chave do contrato
• Na parte de contractSpecifications, devem ser descritos identicamente como os parâmetros da CS em questão que sofrerá o removal. Os campos em questão que devem ser iguais são: “effectValue”, “paymentScheme”, "receivableDebtor", "originalAssetHolder" e "originalAssetHolderDocumentType".
• O “effectEvent” informado deverá ser “Removal” para que a operação ocorra devidamente

Qual notificação será recebida após o processo de Removal?

Assim como nas demais operações de atualização de contratos, será enviada a notificação do tipo "update" após o contrato passar pela operação de Removal.