1. CCB
Iorq Public Routes
  • AUTH
    • Token de acesso
      POST
  • CCB
    • Cessão de CCB com Documentos de Lastro
      POST
    • Recompra de CCB
      POST
    • Liquidação de parcelas
      POST
    • Liquidação antecipada de parcelas
      POST
    • Atualização de status de instrumento financeiro
      PATCH
    • Anexar documentos a uma CCB existente
      POST
    • Renegociação de CCB (sem documento assinado)
      PATCH
    • Renegociação de CCB com Documentos de Lastro
      PATCH
    • Listar CCBs por Filtro
      GET
  • Webhook
    • Create Webhook
      POST
    • List Webhooks
      GET
    • Get Webhook By Id
      GET
    • Update Webhook
      PATCH
  • Webhook Outgoing
    • Payload enviado para a URL do webhook registrado pelo cliente
      POST
  • Esquemas
    • Schemas
      • TokenRequest
      • TokenResponse
      • WebhookBase
      • OperationData
      • Address
      • Borrower
      • Cosigner
      • InstallmentLoanRequest
      • Installment
      • BackingDocument
      • CreateLoanRequest
      • RepurchaseLoanRequest
      • SettleInstallmentRequest
      • PrepaymentInstallment
      • PrepaymentIdentifier
      • InstallmentPrepaymentRequest
      • WebhookCreateSchema
      • WebhookCreateResponseSchema
      • WebhookResponse
      • WebhookUpdateSchema
      • GetAllWebhookResponse
      • HTTPValidationError
      • ValidationError
      • LoanIdentification
      • BaseLoanRequest
      • DocumentInformation
      • LoanRenegotiationRequest
      • LoanFilesRequest
      • LoanStatusUpdateRequest
      • WebhookPayload
  1. CCB

Listar CCBs por Filtro

GET
/loan
Endpoint para listar CCBs aplicando filtros de busca e paginação.
Parâmetro obrigatório (query string):
fund_id: UUID do fundo (credit vehicle) cujas CCBs serão listadas.
Parâmetros opcionais (query string):
name: filtra por nome do tomador (busca parcial).
cpf: filtra por CPF do tomador (apenas dígitos).
state: filtra pelo estado da CCB. Use all (padrão) para não aplicar filtro.
page (default 1) / page_size (default 10): controle de paginação.
id_partner: UUID do parceiro originador.
uf: sigla da UF do endereço do tomador (ex.: SP).
rating: rating do tomador (ex.: A, B).
id_acquisition: UUID da aquisição/lote. Se enviado em formato inválido, a busca retorna lista vazia.
id_loans: lista de UUIDs de CCBs para filtrar. Repetir na query: ?id_loans=...&id_loans=....
originator_product_types: lista de tipos de produto. Repetir na query.
banker_proposal_code: código da proposta no banker.
originator_proposal_code: código da proposta no originador.
O response inclui o objeto cursor com os totais (total_items, total_pages, current_page, page_size) e a lista loans com as CCBs da página atual.
Cada CCB retornada contém também a lista installments com os dados de suas parcelas, incluindo valores financeiros (face, aquisição, curva, pago), datas (vencimento, pagamento), estado e identificadores (code, nosso_numero, registry_code).
Sobre o campo code da parcela:
Dado opcional recebido do originador no momento da cessão via CreateLoanRequest.installments[].code. Representa a identificação/ordem da parcela no sistema do originador. É utilizado como referência nas operações de liquidação (POST /installment/settle) e antecipação (POST /installment/prepayment).

Requisição

Authorization
JWT Bearer
Adicionar o parâmetro
Authorization
a Cabeçalhos
Exemplo:
Authorization: ********************
or
Parâmetros de Consulta

Respostas

🟢200OK
application/json
Lista paginada de CCBs que atendem aos filtros informados.
Bodyapplication/json

🟠401Não Autorizado
🟠422Erro de Parâmetro
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://hs-receiver-app-development.iorq.com.br/api/loan?fund_id=undefined&name=undefined&cpf=undefined&state=undefined&page=undefined&page_size=undefined&uf=undefined&rating=undefined&id_acquisition=undefined&id_loans=undefined&originator_product_types=undefined&banker_proposal_code=undefined&originator_proposal_code=undefined' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso
{
    "cursor": {
        "total_items": 2,
        "total_pages": 1,
        "current_page": 1,
        "page_size": 10
    },
    "loans": [
        {
            "banker_proposal_code": "12312345453",
            "originator_proposal_code": "34586674",
            "originator_product_type": "medical_credit",
            "type": "personal_loan",
            "state": "approved",
            "iof_value": 46.62,
            "tac_value": 30,
            "cet_monthly": 8.856983,
            "fee_value": 13.67,
            "acquisition_value": 3418,
            "face_value": 4095.76,
            "interest_rate_monthly": 7.649999,
            "acquisition_rate_monthly": 5,
            "payment_date": "2025-04-30",
            "date_issued": "2025-03-30",
            "created_at": "2025-03-30T12:34:56-03:00",
            "updated_at": "2025-04-01T09:15:00-03:00",
            "renegotiation_level": 0,
            "installments": [
                {
                    "code": "1",
                    "state": "active",
                    "face_value": 1023.94,
                    "acquisition_value": 854.5,
                    "due_date": "2025-04-30",
                    "nosso_numero": "00001001",
                    "numero_controle": "CTRL-0001",
                    "created_at": "2025-03-30T12:34:56-03:00"
                },
                {
                    "code": "2",
                    "state": "active",
                    "face_value": 1023.94,
                    "acquisition_value": 854.5,
                    "due_date": "2025-05-30",
                    "nosso_numero": "00001002",
                    "created_at": "2025-03-30T12:34:56-03:00"
                },
                {
                    "code": "3",
                    "state": "settled",
                    "face_value": 1023.94,
                    "acquisition_value": 854.5,
                    "paid_amount": 1023.94,
                    "due_date": "2025-06-30",
                    "payment_date": "2025-06-28",
                    "nosso_numero": "00001003",
                    "late_fine_paid": 0,
                    "late_interest_paid": 0,
                    "created_at": "2025-03-30T12:34:56-03:00"
                },
                {
                    "code": "4",
                    "state": "active",
                    "face_value": 1023.94,
                    "acquisition_value": 854.5,
                    "due_date": "2025-07-30",
                    "nosso_numero": "00001004",
                    "created_at": "2025-03-30T12:34:56-03:00"
                }
            ]
        }
    ]
}
Modificado em 2026-05-08 16:45:19
Página anterior
Renegociação de CCB com Documentos de Lastro
Próxima página
Create Webhook
Built with