Inserção de Liquidações

---

Request

ENDPOINT

/settlement/fund_class/FUND_CLASS_KEY/payment_batch/EXTERNAL_ID/settlement

MÉTODO

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 *

Campo	Tipo	Descrição	Caracteres
asset_type *	string	Denomina o tipo de ativo a ser passado	Até 255
total_value *	float	Valor total do pagamento do ativo	Até 24
external_id *	string	Chave única de identificação da liquidação no sistema do parceiro integrador.	Até 50
settlement_type *	string	Denomina o tipo de liquidação a ser passada	Até 50
contract_number	string	Numero do contrato referente aou ativo	Até 50
asset_external_id	string	Chave única de identificação do ativo no sistema.	Até 50
installment_number	int	Número da parcela a ser paga	Até 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

enumerador	Descrição
ccb	Cédula de crédito bancário
cce	Cédula de crédito à exportação
structured_ccb	Cédula de crédito bancário estruturada
structured_cce	Cédula de crédito à exportação estruturada
structured_nce	Nota de crédito à exportação estruturada
structured_cci	Cédula de crédito Imobiliário estruturada
duplicata_mercantil	Duplicata Mercantil
discounted_contract	Contrato

Tipo de Liquidação

enumerador	Descrição
installment_settlement	Liquidação de parcela (nesse caso é necessario passar o campo installment_number)
installment_amortization	Amortização de parcela (nesse caso é necessario passar o campo installment_number)
asset_settlement	Liquidação total do ativo
asset_amortization	Amortização do ativo
gloss	Glosa 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
        }
    ]
}

Possíveis erros

STATUS

404

Response Body

{
  "title": "Payment batch not found",
  "description": "The Payment Batch with external_id {payment_batch_external_id} was not found",
  "translation": "O Lote de Pagamento com identificador externo {payment_batch_external_id} não foi encontrado",
  "code": "SET000010"
}

---

STATUS

400

Response Body

{
  "title": "Already Exists Settlement With External Id",
  "description": "The settlement with external_id {settlement_external_id} in payment batch with external id {payment_batch_external_id} already exists",
  "translation": "a liquidação com identificador {settlement_external_id} no lote de identificador {payment_batch_external_id} já existe",
  "code": "SET000013"
}

---