Developers
API referenceBusiness sign in

Schema

Overstay

Receivers pay overstay by Mobile Money at pickup; a contract that covers overstay pays from the Business wallet up to its limit.

Fields

Overstay fields
FieldTypeDescription
pointTypeRequiredenumOne of POINT, LOCKER
engineRequiredenumHOLD_RULES: NB26 hold terms frozen with the booking. LOCKER_TARIFF: an earlier locker booking keeps its frozen locker tariff.One of HOLD_RULES, LOCKER_TARIFF
readyAtOptionalstring (date-time) or null
holdEndsAtOptionalstring (date-time) or nullEnd of the free (or sender-prepaid, or extended) hold.
chargeStartsAtOptionalstring (date-time) or nullOverstay starts after the grace period.
returnDueAtOptionalstring (date-time) or nullThe parcel returns to the sender after this time.
startedRequiredboolean
daysOptionalinteger
ratePerDayMinorOptionalinteger
capMinorOptionalinteger or null
totalMinorRequiredintegerOverstay through now (or the frozen moment).
assessedMinorOptionalinteger
dueNowMinorRequiredintegerStill to pay before the locker opens or the point releases.
unpaidMinorOptionalinteger
frozenUntilOptionalstring (date-time) or nullThe amount is frozen until this time while the receiver pays.
paymentStateRequiredenumUNCLEAR: the payment is being reconciled; the parcel stays put.One of NONE, DUE, PENDING, UNCLEAR, PAID
obligationsOptionalarray of object
idRequiredstring
chargedToRequiredenumOne of RECEIVER, BUSINESS_WALLET
amountMinorRequiredinteger
statusRequiredstring
attemptOptionalobject or null
publicIdOptionalstring
providerOptionalstring
statusOptionalstring
holdRuleVersionOptionalstring
extensionHoursOptionalinteger

Used by