The Compensation object represents a compensation issued for a contract or claim. It includes the compensation’s amount, status, related identifiers, and operational metadata.
{
"object": "compensation",
"id": "f2d1e03c-82c8-47a6-9774-4b5349f225e7",
"claim_id": "b994d509-c1f9-491c-99d8-65089e9d6d06",
"repair_id": null,
"type": "voucher",
"status": "open",
"amount": 85000,
"currency": "EUR",
"sent_at": "2025-12-01T10:00:00Z"
}Attributes
| name | type | description |
|---|---|---|
| object | string | Fixed value "compensation" - identifies the resource type. |
| id | string | Unique identifier of the compensation. |
| claim_id | string | Identifier of the claim associated with the compensation, if applicable. |
| repair_id | string | Identifier of the repair associated with the compensation, if applicable. |
| type | enum: "wire", "voucher", "card" | The type of the compensation. |
| status | enum: "open", "settled", "cancelled" | Current status of the compensation. |
| amount | integer | Amount of the compensation in minor currency units (e.g., cents). |
| currency | string | ISO 4217 currency code for the compensation amount (e.g., "EUR"). |
| sent_at | string | The date at which the compensation was initiated. |