Skip to main content
GET
/
v1
/
receipts
/
{orderNumber}
Get Receipt
curl --request GET \
  --url https://api.monime.io/v1/receipts/{orderNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "status": "not_redeemed",
    "orderName": "<string>",
    "orderNumber": "<string>",
    "orderAmount": {
      "currency": "<string>",
      "value": 123
    },
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "entitlements": [
      {
        "key": "<string>",
        "name": "<string>",
        "limit": 1,
        "current": 1,
        "remaining": 1,
        "exhausted": true
      }
    ],
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

​
Monime-Version
enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:
caph.2025-08-23,
caph.2025-06-20
​
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64

Path Parameters

​
orderNumber
string
required

The order number of the receipt to retrieve.

Maximum length: 20

Response

200 - application/json

OK

​
success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

​
messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

​
result
object

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.

⌘I