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
| Field | Type | Description |
|---|---|---|
pointTypeRequired | enum | One of POINT, LOCKER |
engineRequired | enum | HOLD_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 |
readyAtOptional | string (date-time) or null | |
holdEndsAtOptional | string (date-time) or null | End of the free (or sender-prepaid, or extended) hold. |
chargeStartsAtOptional | string (date-time) or null | Overstay starts after the grace period. |
returnDueAtOptional | string (date-time) or null | The parcel returns to the sender after this time. |
startedRequired | boolean | |
daysOptional | integer | |
ratePerDayMinorOptional | integer | |
capMinorOptional | integer or null | |
totalMinorRequired | integer | Overstay through now (or the frozen moment). |
assessedMinorOptional | integer | |
dueNowMinorRequired | integer | Still to pay before the locker opens or the point releases. |
unpaidMinorOptional | integer | |
frozenUntilOptional | string (date-time) or null | The amount is frozen until this time while the receiver pays. |
paymentStateRequired | enum | UNCLEAR: the payment is being reconciled; the parcel stays put.One of NONE, DUE, PENDING, UNCLEAR, PAID |
obligationsOptional | array of object | |
idRequired | string | |
chargedToRequired | enum | One of RECEIVER, BUSINESS_WALLET |
amountMinorRequired | integer | |
statusRequired | string | |
attemptOptional | object or null | |
publicIdOptional | string | |
providerOptional | string | |
statusOptional | string | |
holdRuleVersionOptional | string | |
extensionHoursOptional | integer |