{
    "status": "not_redeemed",
    "orderName": null,
    "orderNumber": null,
    "orderAmount": {
        "currency": null,
        "value": null
    },
    "createTime": null,
    "updateTime": null,
    "entitlements": [],
    "metadata": null
}
A Receipt is a record of entitlements generated by Monime whenever a payment completes successfully.
It serves as proof of what the customer is entitled to claim — such as tickets, vouchers, credits, or digital rights.
Receipt links a payment via an order to entitlement claims, enabling both verification and controlled redemption via APIs.

Use Cases

  • Purchase Verification
    Confirm that a customer’s payment went through and display transaction details in your app without manual reconciliation.
  • Ticket & Voucher Redemption
    Use receipts as redeemable proof of access — for example, scanning a receipt at an event gate or validating a voucher at checkout.
  • Partial Consumption
    Support use cases where receipts hold multiple entitlements, such as ride credits or digital assets, and allow them to be redeemed incrementally.
{
    "status": "not_redeemed",
    "orderName": null,
    "orderNumber": null,
    "orderAmount": {
        "currency": null,
        "value": null
    },
    "createTime": null,
    "updateTime": null,
    "entitlements": [],
    "metadata": null
}
📋
Properties
status
enum<string>
Lifecycle status of the receipt.Available options: not_redeemed partially_redeemed fully_redeemed
orderName
string
Human friendly name of the order.
orderNumber
string
Human-friendly order number.
orderAmount
object
Total order amount in minor units and currency.
createTime
string
The timestamp when the receipt was created.
updateTime
string
The last timestamp when the receipt was updated.
entitlements
array
Entitlements granted by this receipt; each can be redeemed until exhausted.
metadata
object
Optional metadata for attaching context or tracking info.