Waafir
Esta página é uma tradução automática pendente de revisão humana. Pode conter erros.

Conciliar os seus dados por ID externo

Esta receita mostra como fechar o ciclo de um envio de ingestão: confirmar que uma linha específica foi gravada, pelo identificador fornecido por você, e verificar se as contagens agregadas por entidade correspondem ao que você enviou. Ambas as leituras têm como escopo a organização e nunca expõem dados de outro tenant.

Por que a conciliação importa

Você enviou hoje ao Waafir um arquivo NDJSON com 1.200 pagamentos. A importação terminou como succeeded, com rowCountSucceeded: 1200. Esse é um sinal. As leituras de conciliação oferecem dois sinais mais fortes:

  • Verificação pontual pelo ID do chamador — escolha um pagamento importante para a sua equipe, consulte-o pelo seu próprio external_id e confirme que os valores correspondem ao que você enviou. O seu identificador é a referência oficial, não o UUID interno do Waafir.
  • Contagens agregadas por entidade — confirme que a contagem de linhas ativas do dia no Waafir corresponde à contagem da sua fonte da verdade. "Enviei 1.200 pagamentos hoje; as contagens dizem que há 1.200 criados hoje. Conciliado."

As leituras são seguras em relação a cache (Cache-Control: private, no-store na consulta por empréstimo), de modo que a resposta reflete a gravação mais recente. Conciliar imediatamente após uma importação retorna o estado recém-gravado.

Os dois endpoints

  • GET /api/v1/monitoring/loan/loans/{externalId}?portfolioId=… — conciliação de um único empréstimo pelo seu próprio external_id. Retorna o corpo do empréstimo e o contexto mascarado do tomador, para que você possa verificar se o empréstimo está vinculado ao tomador esperado, sem uma segunda requisição.
  • GET /api/v1/monitoring/loan/counts?date=YYYY-MM-DD&portfolioId=…&entity=… — contagens de linhas por entidade. Sem entity, retorna as contagens das seis entidades do domínio de empréstimos; com entity, retorna apenas a indicada. O parâmetro date acrescenta uma contagem onDate ao lado da contagem total.

Ambos os endpoints retornam 404 para linhas inexistentes e para linhas que existem em outra organização — o Waafir nunca confirma nem nega a existência de dados de outro tenant.

A receita

# curl — reconcile a single loan and verify per-entity counts
set -euo pipefail

PAT="${WAAFIR_PAT}"
BASE_URL="${WAAFIR_BASE_URL:-https://app.waafir.io}"
PORTFOLIO_ID="${WAAFIR_PORTFOLIO_ID}"
EXTERNAL_LOAN_ID="L-2026-05-22-1234"
TODAY="2026-05-22"

# Step 1 — single-loan reconciliation. The external_id is URL-encoded
# automatically by curl when passed as a positional path segment.
curl -fsS \
  "${BASE_URL}/api/v1/monitoring/loan/loans/${EXTERNAL_LOAN_ID}?portfolioId=${PORTFOLIO_ID}" \
  -H "Authorization: Bearer ${PAT}" \
  | jq '{loan: {externalId: .loan.externalId, principalAmount: .loan.principalAmount, status: .loan.status, disbursementDate: .loan.disbursementDate}, borrower: {externalId: .borrower.externalId, name: .borrower.name, countryCode: .borrower.countryCode}}'

# Step 2 — full per-entity counts for the portfolio.
curl -fsS \
  "${BASE_URL}/api/v1/monitoring/loan/counts?portfolioId=${PORTFOLIO_ID}&date=${TODAY}" \
  -H "Authorization: Bearer ${PAT}" \
  | jq

# Step 3 — counts for just the payments entity (narrower request).
curl -fsS \
  "${BASE_URL}/api/v1/monitoring/loan/counts?portfolioId=${PORTFOLIO_ID}&date=${TODAY}&entity=actual_payments" \
  -H "Authorization: Bearer ${PAT}" \
  | jq
// TypeScript — reconcile a single loan and verify per-entity counts
const PAT = process.env.WAAFIR_PAT!;
const BASE_URL = process.env.WAAFIR_BASE_URL ?? "https://app.waafir.io";
const portfolioId = process.env.WAAFIR_PORTFOLIO_ID!;
const externalLoanId = "L-2026-05-22-1234";
const today = "2026-05-22";

const auth = { Authorization: `Bearer ${PAT}` };

// Step 1 — single-loan reconciliation.
const loanRes = await fetch(
    `${BASE_URL}/api/v1/monitoring/loan/loans/${encodeURIComponent(externalLoanId)}?portfolioId=${portfolioId}`,
    { headers: auth },
);
if (loanRes.status === 404) throw new Error(`loan ${externalLoanId} not found in portfolio ${portfolioId}`);
if (!loanRes.ok) throw new Error(`reconcile failed: ${loanRes.status}`);
const loanBody = (await loanRes.json()) as {
    loan: { externalId: string; principalAmount: string; status: string; disbursementDate: string };
    // borrower may be null if a referential-integrity edge case dropped
    // the borrower row; the response is a partial projection in that case.
    borrower: {
        externalId: string;
        name: string;            // masked (e.g. "M*** S. L."), empty when absent
        countryCode: string | null;
    } | null;
};
console.log({
    loan: {
        externalId: loanBody.loan.externalId,
        principalAmount: loanBody.loan.principalAmount,
        status: loanBody.loan.status,
        disbursementDate: loanBody.loan.disbursementDate,
    },
    borrower: loanBody.borrower
        ? {
              externalId: loanBody.borrower.externalId,
              name: loanBody.borrower.name,
              countryCode: loanBody.borrower.countryCode,
          }
        : null,
});

// Step 2 — full per-entity counts.
const countsRes = await fetch(
    `${BASE_URL}/api/v1/monitoring/loan/counts?portfolioId=${portfolioId}&date=${today}`,
    { headers: auth },
);
console.log("counts:", await countsRes.json());

// Step 3 — narrow to a single entity.
const paymentsRes = await fetch(
    `${BASE_URL}/api/v1/monitoring/loan/counts?portfolioId=${portfolioId}&date=${today}&entity=actual_payments`,
    { headers: auth },
);
console.log("payments:", await paymentsRes.json());
# python — reconcile a single loan and verify per-entity counts
import os
import urllib.parse
import requests

PAT = os.environ["WAAFIR_PAT"]
BASE_URL = os.environ.get("WAAFIR_BASE_URL", "https://app.waafir.io")
portfolio_id = os.environ["WAAFIR_PORTFOLIO_ID"]
external_loan_id = "L-2026-05-22-1234"
today = "2026-05-22"

auth = {"Authorization": f"Bearer {PAT}"}

# Step 1 — single-loan reconciliation. external_id can contain hyphens
# and other URL-safe chars; encode defensively in case yours contain slashes.
encoded = urllib.parse.quote(external_loan_id, safe="")
loan = requests.get(
    f"{BASE_URL}/api/v1/monitoring/loan/loans/{encoded}",
    params={"portfolioId": portfolio_id},
    headers=auth,
    timeout=30,
)
if loan.status_code == 404:
    raise SystemExit(f"loan {external_loan_id} not found in portfolio {portfolio_id}")
loan.raise_for_status()
body = loan.json()
print({
    "loan": {
        "externalId": body["loan"]["externalId"],
        "principalAmount": body["loan"]["principalAmount"],
        "status": body["loan"]["status"],
        "disbursementDate": body["loan"]["disbursementDate"],
    },
    "borrower": {
        "externalId": body["borrower"]["externalId"],
        "name": body["borrower"]["name"],
        "countryCode": body["borrower"]["countryCode"],
    },
})

# Step 2 — full per-entity counts.
counts = requests.get(
    f"{BASE_URL}/api/v1/monitoring/loan/counts",
    params={"portfolioId": portfolio_id, "date": today},
    headers=auth,
    timeout=30,
).json()
print("counts:", counts)

# Step 3 — narrow to one entity.
payments = requests.get(
    f"{BASE_URL}/api/v1/monitoring/loan/counts",
    params={"portfolioId": portfolio_id, "date": today, "entity": "actual_payments"},
    headers=auth,
    timeout=30,
).json()
print("payments:", payments)

O que verificar

Na resposta de um único empréstimo, todos os campos que você enviou sob o seu external_id devem voltar idênticos: principalAmount, currencyCode, interestRateApr, disbursementDate, termMonths, repaymentFrequency, productType, status, metadata. A seção do tomador é mascarada de acordo com a política de PII do Waafir — name, email, phone e nationalIdLast4 são mascarados por padrão neste endpoint; os campos que não são PII (countryCode, dob, gender, incomeBand, employmentStatus) são retornados sem alteração.

Na resposta de contagens, os totais têm como escopo a sua organização e excluem linhas excluídas logicamente (soft delete). Com ?date=YYYY-MM-DD, a entrada de cada entidade inclui uma contagem onDate — linhas criadas nessa data — ao lado do total geral. A contagem onDate é o seu sinal de que o envio foi correspondido.

Um 404 no endpoint de um único empréstimo sempre significa que o empréstimo não está visível para a sua organização naquele portfólio. Ele pode não existir, ou pode existir em outra organização; a resposta intencionalmente não faz distinção.