Cartera

Préstamos del afiliado #

GET/v1/gateway/loans/

• operationId listLoans
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.list()

client.loans.list()

$client->loans->list()

await client.Loans.ListAsync()

client.Loans.List(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/?document=1032456789" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Detalle de un préstamo #

GET/v1/gateway/loans/{loan_id}/

• operationId getLoan
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.get()

client.loans.get()

$client->loans->get()

await client.Loans.GetAsync()

client.Loans.Get(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Certificado de deuda / paz y salvo #

GET/v1/gateway/loans/{loan_id}/certificate/

• operationId getLoanCertificate
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.certificate()

client.loans.certificate()

$client->loans->certificate()

await client.Loans.CertificateAsync()

client.Loans.Certificate(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/certificate/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar un abono a capital #

POST/v1/gateway/loans/{loan_id}/extra-payment/

• operationId registerLoanExtraPayment
• Autenticación X-API-Key · scope loans:collect
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema 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.

Respuestas

Ejemplo

client.loans.register_extra_payment()

client.loans.registerExtraPayment()

$client->loans->registerExtraPayment()

await client.Loans.RegisterExtraPaymentAsync()

client.Loans.RegisterExtraPayment(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/extra-payment/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "amount": "195000",
    "channel": "CASH",
    "reference": "REC-2026-001"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Simular un abono extraordinario #

GET/v1/gateway/loans/{loan_id}/extra-payment/quote/

• operationId quoteLoanExtraPayment
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.quote_extra_payment()

client.loans.quoteExtraPayment()

$client->loans->quoteExtraPayment()

await client.Loans.QuoteExtraPaymentAsync()

client.Loans.QuoteExtraPayment(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/extra-payment/quote/?amount=<amount>" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Plan de pagos #

GET/v1/gateway/loans/{loan_id}/installments/

• operationId listLoanInstallments
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.installments()

client.loans.installments()

$client->loans->installments()

await client.Loans.InstallmentsAsync()

client.Loans.Installments(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/installments/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Detalle de una cuota #

GET/v1/gateway/loans/{loan_id}/installments/{number}/

• operationId getLoanInstallment
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.get_installment()

client.loans.getInstallment()

$client->loans->getInstallment()

await client.Loans.GetInstallmentAsync()

client.Loans.GetInstallment(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/installments/4/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Desglose de una cuota (cómo se aplicaría un pago) #

GET/v1/gateway/loans/{loan_id}/installments/{number}/breakdown/

• operationId getLoanInstallmentBreakdown
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.installment_breakdown()

client.loans.installmentBreakdown()

$client->loans->installmentBreakdown()

await client.Loans.InstallmentBreakdownAsync()

client.Loans.InstallmentBreakdown(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/installments/4/breakdown/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Historial de pagos #

GET/v1/gateway/loans/{loan_id}/payments/

• operationId listLoanPayments
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.payments()

client.loans.payments()

$client->loans->payments()

await client.Loans.PaymentsAsync()

client.Loans.Payments(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/payments/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar un pago recibido por la entidad #

POST/v1/gateway/loans/{loan_id}/payments/

• operationId registerLoanPayment
• Autenticación X-API-Key · scope loans:collect
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema 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.

Respuestas

Ejemplo

client.loans.register_payment()

client.loans.registerPayment()

$client->loans->registerPayment()

await client.Loans.RegisterPaymentAsync()

client.Loans.RegisterPayment(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/payments/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "amount": "195000",
    "channel": "CASH",
    "reference": "REC-2026-001"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar el pago total anticipado #

POST/v1/gateway/loans/{loan_id}/payoff/

• operationId registerLoanPayoff
• Autenticación X-API-Key · scope loans:collect
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema 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.

Respuestas

Ejemplo

client.loans.register_payoff()

client.loans.registerPayoff()

$client->loans->registerPayoff()

await client.Loans.RegisterPayoffAsync()

client.Loans.RegisterPayoff(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/payoff/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "amount": "195000",
    "channel": "CASH",
    "reference": "REC-2026-001"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Cotizar el pago total de hoy #

GET/v1/gateway/loans/{loan_id}/payoff/quote/

• operationId quoteLoanPayoff
• Autenticación X-API-Key · scope loans:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.loans.quote_payoff()

client.loans.quotePayoff()

$client->loans->quotePayoff()

await client.Loans.QuotePayoffAsync()

client.Loans.QuotePayoff(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/loans/3f1c2e7a-4b8d-4e6f-a1c0-d2e3f4a5b6c7/payoff/quote/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.