Esquemas

AdminEmployeeIn #

Alta o actualización de un colaborador (upsert por id_number). Los datos bancarios solo se aceptan en el alta; cambiarlos después se hace en el panel. user_id no se acepta.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminEntryIn #

Comprobante contable en BORRADOR. external_id (id del ERP) lo hace idempotente en el motor. post: true se rechaza: el contador contabiliza en el panel.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminHrNoveltyIn #

Novedad de talento humano. Queda SOLICITADA hasta que talento humano la valide.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminObject #

Objeto del motor administrativo (mismo payload que usa el panel).

Tipo: object

AdminPayrollNovelty #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminPayrollNoveltyIn #

Una novedad (campos de AdminPayrollNovelty en la raíz) o un lote en items (máx. 500, todo o nada). period_id opcional: valida que el periodo esté abierto y que la fecha caiga dentro; sin date, se usa el inicio del periodo.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminResultList #

Lista del motor administrativo (results; count en las paginadas).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminStatementIn #

Extracto bancario: lines (JSON) o content (CSV con fecha y valor).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminTaxComputeIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminThirdPartyIn #

Alta o actualización de un tercero (upsert por tipo y número de documento). id_type acepta el código DIAN (31, 13…) o el alias (NIT, CC, CE, PA…). Datos bancarios: solo en el panel.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AdminTreasuryDocIn #

Recaudo / egreso (third_party, bank_account id o número, date, amount, method, reference, applications) o cuenta de cobro (third_party, issue_date, description, income_account, subtotal, iva_concept). Siempre en BORRADOR.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

AffiliateBatchResult #

AffiliateLookup #

AffiliateRecordIn #

A single affiliate row. Keys are normalized at the edge, so both Spanish source headers (tipo_documento, documento, nombres) and canonical keys are accepted; unknown keys are ignored.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "category": "A",
  "document_number": "1032456789",
  "document_type": "CC",
  "email": "maria.gomez@example.co",
  "first_name": "María",
  "last_name": "Gómez"
}

AffiliateRef #

Minimal reference to an affiliate by national document.

CreditApplicationIn #

Credit application radicada into the BRE pipeline. Proxied to the engine as-is.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "afiliado": {
    "document_number": "1032456789",
    "document_type": "CC"
  },
  "amount": "3500000",
  "external_reference": "HORIZONTE-CRED-2026-000123",
  "product_code": "LIBRANZA_12M",
  "purpose": "Compra de cartera",
  "term_months": 12
}

CreditDecisionIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "approved_amount": "3500000",
  "decision": "APPROVE",
  "reason": "Cumple capacidad de pago."
}

FieldError #

A single field-level validation failure.

FxConvertIn #

Execute a currency conversion (moves money — idempotency-key recommended).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "amount": "1000000",
  "buy_currency": "USD",
  "document": "1032456789",
  "quote_id": "fxq_abc123",
  "sell_currency": "COP"
}

FxQuote #

Indicative pricing. The rate is re-resolved when the conversion executes.

FxQuoteIn #

Request an indicative FX quote (moves no money, not billable).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "amount": "1000000",
  "buy_currency": "USD",
  "document": "1032456789",
  "sell_currency": "COP"
}

GatewayHealth #

LoanCertificate #

Certificado de deuda a una fecha; paz_y_salvo=true cuando el crédito está saldado.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

LoanCollectionIn #

Recaudo reportado por la entidad. La reference es la llave natural del recibo (préstamo + canal + referencia): reenviarla devuelve el mismo recibo; con otro monto → 409.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "amount": "195000",
  "channel": "CASH",
  "document": "1032456789",
  "reference": "REC-2026-001"
}

LoanInstallment #

Cuota del plan de pagos (mismo formato que ve el afiliado en la app).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

LoanInstallmentList #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

LoanList #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

LoanNextInstallment #

LoanQuote #

Cotización (pago total de hoy, abono extraordinario o desglose de cuota).

Tipo: object

LoanSummary #

Resumen de un préstamo desembolsado (motor: GwLoans._summary).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

MonetaryAllowanceGenerateIn #

Evaluate eligibility and generate the period’s cuota monetaria for the caja.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "dry_run": false,
  "period": "2026-06"
}

MoneyCOP #

A monetary amount in Colombian pesos (COP), as a decimal string to avoid float drift.

Tipo: string · patrón ^\d+(\.\d{1,2})?$ · ej. "3500000"

Page #

DRF-style paginated list proxied from the processing engine.

Pqrs #

A PQRS. affiliate.name is masked; description, responses, attachments and history are present on detail and write responses.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

PqrsPage #

PqrsRespondIn #

PqrsStats #

PqrsStatusIn #

Change status following the PQRS state machine: closed is terminal, resolved can only be closed; repeating the current status is an idempotent no-op.

PqrsSubmitIn #

File a PQRS on behalf of an affiliate. The radicado (PQRS-AAAA-NNNNNN) and the legal deadline (15 business days, Ley 1755/2015) are set by the engine.

{
  "agent": "ana.p",
  "description": "El afiliado reporta un cobro de 45.000 que no reconoce.",
  "document": "1032456789",
  "electronic_notification_consented": true,
  "external_reference": "CRM-88231",
  "issue_type": "claim",
  "origin_channel": "call_center",
  "service_area": "wallet",
  "subject": "Cobro no reconocido"
}

Problem #

RFC 9457 application/problem+json error envelope (GW-006). The same shape is returned for every error; trace_id equals the X-Request-ID response header and should be quoted to support.

SubsidyApplicationIn #

Statutory subsidy application. subsidy_type is the path segment (e.g. unemployment).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "afiliado": {
    "document_number": "1032456789",
    "document_type": "CC"
  },
  "external_reference": "HORIZONTE-SUB-2026-000045",
  "period": "2026-06"
}

SubsidyDecisionIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "decision": "APPROVE",
  "reason": "Cumple requisitos de permanencia."
}

TransactionEnvelope #

Standard async-write acknowledgement. data carries the engine response verbatim; idempotent_replay is true when a prior request with the same Idempotency-Key is being replayed.

TransactionStatus #

Persisted gateway transaction log record.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletAccount #

One account owned by the holder (primary wallet, pocket, or savings goal).

WalletAccountCreateIn #

Create a sub-account (pocket / savings / goal) for the wallet holder.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "document": "1032456789",
  "kind": "pocket",
  "name": "Ahorro vacaciones"
}

WalletAccountList #

WalletBalance #

WalletBillInquiryIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletBillPayIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletBillPayment #

WalletBillPaymentPage #

WalletBillerList #

WalletBreBLimits #

WalletBreBResolveIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletCard #

Non-sensitive card metadata. PAN/CVV are never returned here.

WalletCardIssueIn #

Issue a card (debit; virtual or physical) for the wallet holder.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "document": "1032456789",
  "form_factor": "virtual"
}

WalletCardList #

WalletCardStatusIn #

Change a card’s state (freeze / unfreeze / block).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "document": "1032456789",
  "status": "freeze"
}

WalletCardTransactionList #

Movements on one card, most recent first.

WalletDocument #

Document id of the wallet holder; the engine resolves the member from it.

Tipo: string · ej. "1090123456"

WalletInvoice #

WalletResolution #

Destinatario enmascarado y token de envío (vida corta, 300 s).

WalletResolveP2PIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletTopupIn #

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WalletTopupOperators #

WalletTransaction #

WalletTransactionPage #

WalletTransferIn #

Transfer funds between two of the holder’s own accounts.

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

{
  "amount": "150000",
  "document": "1032456789",
  "from_account": "acc_main",
  "to_account": "acc_pocket_1"
}

WalletTransferIn2 #

Envío P2P o Bre-B: solo con el resolution_token del resolve (nunca un id suelto).

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

WebhookDeliveryDetail #

A delivery with every attempt of the same event (original + replays). Request headers other than the signature headers are redacted; the secret is never returned.

WebhookDeliveryList #

WebhookDeliverySummary #

WebhookEndpoint #

An outbound endpoint of the organization. Never carries the secret on reads.

WebhookEndpointCreateIn #

WebhookEndpointList #

WebhookEndpointUpdateIn #

Partial update. Only these fields are accepted.

WebhookEventCatalog #

Every subscribable event plus the signature contract of outbound deliveries.

WebhookEventInfo #

WebhookTestIn #