Referencia del API · tag monetary-allowance
Cuota monetaria
Generación del período de cuota monetaria, consulta y desembolso.
Esta página se genera desde el contrato (data/gateway-v1.json): cada operación muestra su verbo,
ruta, parámetros, cuerpo, respuestas, si lleva Idempotency-Key y el método equivalente en los cinco SDK.
Para el flujo de punta a punta con ejemplos completos, ve a la guía de implementación.
Operaciones del tag monetary-allowance #
Descripción en el contrato: Cuota monetaria eligibility, period generation and disbursement.
| Método | Ruta | Operación | Scope | Idem. |
|---|---|---|---|---|
| GET | /v1/gateway/subsidies/monetary-allowance/ | List the period's cuotas monetarias | subsidies:read | — |
| POST | /v1/gateway/subsidies/monetary-allowance/generate/ | Evaluate eligibility and generate the period's cuota monetaria | subsidies:submit | recomendada |
| POST | /v1/gateway/subsidies/monetary-allowance/{disb_id}/disburse/ | Disburse a cuota monetaria | subsidies:disburse | recomendada |
List the period's cuotas monetarias #
GET/v1/gateway/subsidies/monetary-allowance/
Parámetros
| Nombre | En | Tipo | Descripción |
|---|---|---|---|
period | query | string | Settlement period YYYY-MM. Ej.: 2026-06 |
page | query | integer | |
page_size | query | integer | |
status | query | string |
Respuestas
| Código | Descripción | Cuerpo |
|---|---|---|
| 200 | Paginated cuotas monetarias. | Page
application/json |
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
| 400 | Malformed request. | about:blank |
| 401 | Missing or invalid API key. | about:blank |
| 403 | The key is valid but lacks the required scope, or the source IP is not allow-listed. | about:blank |
| 404 | The requested resource does not exist. | about:blank |
| 409 | Idempotency conflict — same key, original still processing. | https://errors.compense.co/gateway/idempotency-conflict |
| 422 | Request body failed validation. | https://errors.compense.co/gateway/validation |
| 429 | Per-key rate limit or monthly quota exceeded; see Retry-After. | https://errors.compense.co/gateway/rate-limited |
| 500 | Unexpected gateway error; quote the trace_id to support. | about:blank |
| 502 | The processing engine returned an error. | https://errors.compense.co/gateway/upstream-error |
| 504 | The processing engine did not respond in time. | https://errors.compense.co/gateway/upstream-error |
Ver Errores problem+json para la excepción equivalente en cada SDK.
Ejemplo
client.monetary_allowance.list()client.monetaryAllowance.list()$client->monetaryAllowance->list()await client.MonetaryAllowance.ListAsync()client.MonetaryAllowance.List(ctx, …)curl "https://sandbox.dev.compense.co/gw/v1/gateway/subsidies/monetary-allowance/" \
-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.
Evaluate eligibility and generate the period's cuota monetaria #
POST/v1/gateway/subsidies/monetary-allowance/generate/
Parámetros
| Nombre | En | Tipo | Descripción |
|---|---|---|---|
Idempotency-Key | cabecera | string | Client-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123 |
Cuerpo de la petición
Tipo de contenido: application/json · obligatorio
Esquema MonetaryAllowanceGenerateIn — Evaluate eligibility and generate the period’s cuota monetaria for the caja.
| Campo | Tipo | Descripción |
|---|---|---|
dry_run | boolean | Evaluate without persisting disbursements. Ej.: false |
period obligatorio | string | Settlement period YYYY-MM. Ej.: "2026-06" |
Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.
Respuestas
| Código | Descripción | Cuerpo |
|---|---|---|
| 200 | Accepted; transaction enqueued / processed. | TransactionEnvelope
application/json |
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
| 400 | Malformed request. | about:blank |
| 401 | Missing or invalid API key. | about:blank |
| 403 | The key is valid but lacks the required scope, or the source IP is not allow-listed. | about:blank |
| 404 | The requested resource does not exist. | about:blank |
| 409 | Idempotency conflict — same key, original still processing. | https://errors.compense.co/gateway/idempotency-conflict |
| 422 | Request body failed validation. | https://errors.compense.co/gateway/validation |
| 429 | Per-key rate limit or monthly quota exceeded; see Retry-After. | https://errors.compense.co/gateway/rate-limited |
| 500 | Unexpected gateway error; quote the trace_id to support. | about:blank |
| 502 | The processing engine returned an error. | https://errors.compense.co/gateway/upstream-error |
| 504 | The processing engine did not respond in time. | https://errors.compense.co/gateway/upstream-error |
Ver Errores problem+json para la excepción equivalente en cada SDK.
Ejemplo
client.monetary_allowance.generate()client.monetaryAllowance.generate()$client->monetaryAllowance->generate()await client.MonetaryAllowance.GenerateAsync()client.MonetaryAllowance.Generate(ctx, …)curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/subsidies/monetary-allowance/generate/" \
-H "X-API-Key: $COMPENSE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"period": "2026-06",
"dry_run": false
}'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.
Disburse a cuota monetaria #
POST/v1/gateway/subsidies/monetary-allowance/{disb_id}/disburse/
Parámetros
| Nombre | En | Tipo | Descripción |
|---|---|---|---|
disb_id obligatorio | ruta | string | Disbursement id. Ej.: MA-2026-06-000777 |
Idempotency-Key | cabecera | string | Client-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123 |
Respuestas
| Código | Descripción | Cuerpo |
|---|---|---|
| 200 | Accepted; transaction enqueued / processed. | TransactionEnvelope
application/json |
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
| 400 | Malformed request. | about:blank |
| 401 | Missing or invalid API key. | about:blank |
| 403 | The key is valid but lacks the required scope, or the source IP is not allow-listed. | about:blank |
| 404 | The requested resource does not exist. | about:blank |
| 409 | Idempotency conflict — same key, original still processing. | https://errors.compense.co/gateway/idempotency-conflict |
| 422 | Request body failed validation. | https://errors.compense.co/gateway/validation |
| 429 | Per-key rate limit or monthly quota exceeded; see Retry-After. | https://errors.compense.co/gateway/rate-limited |
| 500 | Unexpected gateway error; quote the trace_id to support. | about:blank |
| 502 | The processing engine returned an error. | https://errors.compense.co/gateway/upstream-error |
| 504 | The processing engine did not respond in time. | https://errors.compense.co/gateway/upstream-error |
Ver Errores problem+json para la excepción equivalente en cada SDK.
Ejemplo
client.monetary_allowance.disburse()client.monetaryAllowance.disburse()$client->monetaryAllowance->disburse()await client.MonetaryAllowance.DisburseAsync()client.MonetaryAllowance.Disburse(ctx, …)curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/subsidies/monetary-allowance/MA-2026-06-000777/disburse/" \
-H "X-API-Key: $COMPENSE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"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.