Pular para o conteúdo principal

Liquidação Externa de Parcela

Para sensibilizar uma liquidação de parcela com cobrança externa ao ambiente da QI Tech, é necessário realizar a requisição abaixo passando a chave da operação de crédito e a chave da parcela a ser paga.

Em uma liquidação parcial (paid_partial) o valor pago deve ser menor que o valor presente da parcela, caso contrário receberá um erro de Bad Request na requisição com código COP000462.

Na liquidação completa (paid) o valor pago deve ser menor ou igual ao valor presente da parcela, resultando em um erro de Bad Request na requisição com código COP000463.

POST
/credit_operation/DEBT_KEY/installment/INSTALLMENT_KEY/external_payment

Request

Request Body
{
"installment_status": "paid",
"paid_amount": 170.15,
"paid_at": "2025-01-01 14:30:00",
"paid_method_type": "pix",
}

Detalhes da Request

CampoTipoObservações
installment_statusstringPrecisa ser 'paid' ou 'paid_partial'
paid_amountfloatNúmeros maiores que zero
paid_atdatetimeData no formato 'YYYY-mm-dd HH:MM:SS'
paid_method_typestringPrecisar ser 'pix', 'ted' ou 'bankslip'

Response

STATUS
200 OK
Response Body
{
"installment_key": "194e8ae3-50da-415b-84ec-7554e28e1b28",
"installment_status": "paid_early",
"calendar_days": 32,
"due_date": "2025-01-28",
"business_due_date": "2025-01-28",
"installment_number": 6,
"due_principal": 915.52487749,
"total_amount": 170.15,
"pre_fixed_amount": 65.35867370,
"post_fixed_amount": 0,
"tax_amount": 2.04510752,
"installment_payment": {
"installment_payment_key": "51708ac1-48fa-4156-80c2-3a24210ae19f"
}
}

Detalhes da Response

CampoTipoObservações
installment_keystringChave única de identificação da parcela
installment_statusstringPode ser 'paid', 'paid_early', 'paid_overdue', 'paid_partial' ou 'paid_partial_overdue'
calendar_daysintQuantidade de dias corridos desde a última parcela
due_datedateData do vencimento da parcela
business_due_datedateData do vencimento da parcela em dia útil
installment_numberintNúmero da parcela
due_principalfloatPrincipal restante da operação utilizado para calcular o juros da parcela
total_amountfloatValor de face da parcela
pre_fixed_amountfloatJuros pré incluso no valor da parcela
post_fixed_amountfloatJuros pós incluso no valor da parcela
tax_amountfloatValor dos impostos recolhidos em relação ao due_principal
installment_payment_keystringChave única de identificação do pagamento
atenção

Os possíveis valores para o enumerador installment_status são resultantes do status passado na requisição combinado com a data do pagamento em relação ao vencimento da parcela, indicando se é um pagamento devido, adiantado ou atrasado.