v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Renegotiation

Consultar as campanhas de renegociação ativas para o(s) contrato(s)

O objetivo dessa rota é consultar as campanhas ativas do(s) contrato(s).

get/renegotiation/{customer_tax_id}/campaigns

Path parameters

customer_tax_idstring required

Identificador do cliente

Identificação do cliente

Query parameters

fund_tax_idstring required

CNPJ/CPF

Example:15996430000182

Identificação do fundo

contract[]string[] required

Identificador do(s) contrato(s)

[
  "6764459321/EP"
]

Response

Sucesso

affinity_scorenumber

codestring

guarantor_typestring

installment_agreement_type'Disabled' | 'OnlyVNP' | 'NotVNP' | 'All'

interest_payment_typestring

interest_ratenumber

minimum_installment_amountnumber

minimun_entry_amountnumber

namestring

payment_datesstring[]

payment_periodicitystring

Example response

[
  {
    "affinity_score": 5,
    "code": "123456",
    "first_payment_options": [
      {
        "description": "Boleto",
        "id": 1,
        "name": "BANKSLIP"
      }
    ],
    "grace_period_flow": {
      "name": "Carência de Parcelas",
      "type": "Cashflow"
    },
    "guarantor_type": "ORIGINAL",
    "installment_agreement_type": "All",
    "installment_ranges": [
      {
        "discount_fields": [
          {
            "text": "Principal",
            "value": "Main"
          }
        ],
        "max_installments": 1,
        "min_installments": 1
      }
    ],
    "installments_payment_options": [
      {
        "description": "Boleto",
        "id": 1,
        "name": "BANKSLIP"
      }
    ],
    "interest_payment_type": "Juros Originais",
    "minimum_installment_amount": 0.1,
    "minimun_entry_amount": 155.56,
    "name": "123456",
    "payment_dates": [
      "2023-08-30"
    ]
  }
]