Developers
API referenceBusiness sign in

Schema

Claim

A parcel claim. Internal liability findings and staff names are never returned.

Fields

Claim fields
FieldTypeDescription
idRequiredstringClaim IDPattern ^(?:QD-CLM-[A-F0-9]{24}|QDCLM[A-Z0-9]{3,31})$
statusRequiredClaimStatusAWAITING_APPROVAL: approved above the threshold and waiting for a second supervisor. PAID: the compensation was sent.
reasonRequiredClaimReasonLOSS, DAMAGE, MISSING_ITEMS, DELAY (the delivery promise was missed) or WRONG_DELIVERY.
descriptionOptionalstring
declaredValueMinorRequiredintegerDeclared value of the contents in pesewas (0 for DELAY).
currencyRequired"GHS"
shipmentRequiredobject
trackingNumberOptionalstring or null
idOptionalstring or null
claimantOptionalenumOne of SENDER, RECEIVER, MERCHANT
sourceOptionalenumOne of PERSONAL, BUSINESS, API, STAFF
windowEndsAtOptionalstring (date-time) or nullLast moment this parcel could be claimed.
liabilityCapMinorRequiredintegerLiability cap for this product, after your contract terms.
approvedMinorRequiredinteger or nullApproved compensation once decided.
decisionReasonOptionalstring or null
decidedAtOptionalstring (date-time) or null
caseReferenceOptionalstring or nullThe linked support case (QD-SUP-…).
createdAtRequiredstring (date-time)
updatedAtOptionalstring (date-time)
evidenceOptionalarray of ClaimEvidence
payoutsOptionalarray of ClaimPayout
timelineOptionalarray of object
typeRequiredstring
atRequiredstring (date-time)

Used by