API reference · tag monetary-allowance
Monetary allowance
Generating the monetary allowance period, looking it up and disbursing it.
This page is generated from the contract (data/gateway-v1.json): each operation shows its verb,
path, parameters, body, responses, whether it carries an Idempotency-Key, and the equivalent method in all five SDKs.
For the end-to-end flow with complete examples, see the implementation guide.
Operations in tag monetary-allowance #
Contract description: Monetary allowance eligibility, period generation and disbursement.
| Method | Path | Operation | Scope | Idem. |
|---|---|---|---|---|
| GET | /v1/gateway/subsidies/monetary-allowance/ | List the period's monetary allowances | subsidies:read | — |
| POST | /v1/gateway/subsidies/monetary-allowance/generate/ | Evaluate eligibility and generate the period's monetary allowance | subsidies:submit | recommended |
| POST | /v1/gateway/subsidies/monetary-allowance/{disb_id}/disburse/ | Disburse a monetary allowance | subsidies:disburse | recommended |
List the period's monetary allowances #
GET/v1/gateway/subsidies/monetary-allowance/
Parameters
| Name | In | Type | Description |
|---|---|---|---|
period | query | string | Settlement period YYYY-MM. E.g.: 2026-06 |
page | query | integer | |
page_size | query | integer | |
status | query | string |
Responses
| Code | Description | Body |
|---|---|---|
| 200 | Paginated monetary allowances. | Page
application/json |
Possible errors (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 |
See problem+json errors for the equivalent exception in each SDK.
Example
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"Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.
Evaluate eligibility and generate the period's monetary allowance #
POST/v1/gateway/subsidies/monetary-allowance/generate/
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Idempotency-Key | header | 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. E.g.: horizonte-2026-06-26-credit-000123 |
Request body
Content type: application/json · required
Schema MonetaryAllowanceGenerateIn — Evaluate eligibility and generate the period’s monetary allowance for the compensation fund.
| Field | Type | Description |
|---|---|---|
dry_run | boolean | Evaluate without persisting disbursements. E.g.: false |
period required | string | Settlement period YYYY-MM. E.g.: "2026-06" |
Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.
Responses
| Code | Description | Body |
|---|---|---|
| 200 | Accepted; transaction enqueued / processed. | TransactionEnvelope
application/json |
Possible errors (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 |
See problem+json errors for the equivalent exception in each SDK.
Example
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
}'Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.
Disburse a monetary allowance #
POST/v1/gateway/subsidies/monetary-allowance/{disb_id}/disburse/
Parameters
| Name | In | Type | Description |
|---|---|---|---|
disb_id required | path | string | Disbursement id. E.g.: MA-2026-06-000777 |
Idempotency-Key | header | 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. E.g.: horizonte-2026-06-26-credit-000123 |
Responses
| Code | Description | Body |
|---|---|---|
| 200 | Accepted; transaction enqueued / processed. | TransactionEnvelope
application/json |
Possible errors (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 |
See problem+json errors for the equivalent exception in each SDK.
Example
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)"Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.