Loans

Affiliate's loans #

GET/v1/gateway/loans/

• operationId listLoans
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Loan detail #

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

• operationId getLoan
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Debt certificate / paid-in-full certificate (paz y salvo) #

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

• operationId getLoanCertificate
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register a principal prepayment #

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

• operationId registerLoanExtraPayment
• Authentication X-API-Key · scope loans:collect
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema LoanCollectionIn — Collection reported by the entity. The reference is the receipt’s natural key (loan + channel + reference): resending it returns the same receipt; with a different amount → 409.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

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"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Simulate an extra payment #

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

• operationId quoteLoanExtraPayment
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payment plan #

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

• operationId listLoanInstallments
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Installment detail #

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

• operationId getLoanInstallment
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Installment breakdown (how a payment would be applied) #

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

• operationId getLoanInstallmentBreakdown
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payment history #

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

• operationId listLoanPayments
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register a payment received by the entity #

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

• operationId registerLoanPayment
• Authentication X-API-Key · scope loans:collect
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema LoanCollectionIn — Collection reported by the entity. The reference is the receipt’s natural key (loan + channel + reference): resending it returns the same receipt; with a different amount → 409.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

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"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register an early full payoff #

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

• operationId registerLoanPayoff
• Authentication X-API-Key · scope loans:collect
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema LoanCollectionIn — Collection reported by the entity. The reference is the receipt’s natural key (loan + channel + reference): resending it returns the same receipt; with a different amount → 409.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

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"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Quote today's full payoff #

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

• operationId quoteLoanPayoff
• Authentication X-API-Key · scope loans:read
• Idempotency-Key not applicable

Parameters

Responses

Example

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"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.