Skip to main content

Inserção de Liquidações


Request

ENDPOINT
/settlement/fund_class/FUND_CLASS_KEY/payment_batch/EXTERNAL_ID/settlement
METHOD
POST
Request Body
{
"asset_type": "ccb",
"total_value": 130.50,
"external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"settlement_type": "installment_settlement",
"contract_number":"0123456789/ABC",
"installment_number": 1,
}
Atenção

Os campos asset_external_id e contract_number são identificadores do ativo no sistema, é importante que um OU o outro seja passado, mas NÃO ambos simultaneamente

Body Params

campo obrigatório *

CampoTipoDescriçãoCaracteres
asset_type *stringDenomina o tipo de ativo a ser passadoAté 255
total_value *floatValor total do pagamento do ativoAté 24
external_id *stringChave única de identificação da liquidação no sistema do parceiro integrador.Até 50
settlement_type *stringDenomina o tipo de liquidação a ser passadaAté 50
contract_numberstringNumero do contrato referente aou ativoAté 50
asset_external_idstringChave única de identificação do ativo no sistema.Até 50
installment_numberintNúmero da parcela a ser pagaAté 24
Informação

O campo external_id no corpo da reqsuisição se refere ao identificador da Liquidação e o campo EXTERNAL_ID no endpoint se refere ao identificador do Lote

Tipo de Ativos

enumeradorDescrição
ccbCédula de crédito bancário
cceCédula de crédito à exportação
structured_ccbCédula de crédito bancário estruturada
structured_cceCédula de crédito à exportação estruturada
structured_nceNota de crédito à exportação estruturada
structured_cciCédula de crédito Imobiliário estruturada
duplicata_mercantilDuplicata Mercantil
discounted_contractContrato

Tipo de Liquidação

enumeradorDescrição
installment_settlementLiquidação de parcela (nesse caso é necessario passar o campo installment_number)
installment_amortizationAmortização de parcela (nesse caso é necessario passar o campo installment_number)
asset_settlementLiquidação total do ativo
asset_amortizationAmortização do ativo
glossGlosa de ativos

Response

STATUS
201
Request Body
{
"status": "validated",
"total_value": 130.50,
"external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"installment_number": 1,
"type":"installment_settlement",
"settlement_result":0.0,
"assets":[
{
"asset_key": "f34e9437-d025-41ab-bb53-6b94e10fd361",
"number_of_units": 1,
"present_value": 1250.00,
"installment_face_value":130.50
}
]
}