Schema
Claim
A parcel claim. Internal liability findings and staff names are never returned.
Fields
| Field | Type | Description |
|---|---|---|
idRequired | string | Claim IDPattern ^(?:QD-CLM-[A-F0-9]{24}|QDCLM[A-Z0-9]{3,31})$ |
statusRequired | ClaimStatus | AWAITING_APPROVAL: approved above the threshold and waiting for a second supervisor. PAID: the compensation was sent. |
reasonRequired | ClaimReason | LOSS, DAMAGE, MISSING_ITEMS, DELAY (the delivery promise was missed) or WRONG_DELIVERY. |
descriptionOptional | string | |
declaredValueMinorRequired | integer | Declared value of the contents in pesewas (0 for DELAY). |
currencyRequired | "GHS" | |
shipmentRequired | object | |
trackingNumberOptional | string or null | |
idOptional | string or null | |
claimantOptional | enum | One of SENDER, RECEIVER, MERCHANT |
sourceOptional | enum | One of PERSONAL, BUSINESS, API, STAFF |
windowEndsAtOptional | string (date-time) or null | Last moment this parcel could be claimed. |
liabilityCapMinorRequired | integer | Liability cap for this product, after your contract terms. |
approvedMinorRequired | integer or null | Approved compensation once decided. |
decisionReasonOptional | string or null | |
decidedAtOptional | string (date-time) or null | |
caseReferenceOptional | string or null | The linked support case (QD-SUP-…). |
createdAtRequired | string (date-time) | |
updatedAtOptional | string (date-time) | |
evidenceOptional | array of ClaimEvidence | |
payoutsOptional | array of ClaimPayout | |
timelineOptional | array of object | |
typeRequired | string | |
atRequired | string (date-time) |