Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperrail.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Events

Event NameEvent TypeDescription
Order Successfulorder_successfulTriggered when an order is successfully processed.
Quote Expiredquote_expiredOccurs when a quote expires due to an unfulfilled order and time to live expiration.

​
Payload Example Structure

​
Order Successful

{
  "data": {
    "quote_id": "1065af43-b784-4315-a3dd-d94e710395bc",
    "merchant_id": "e7f46e55-240b-4337-b16e-6cbf6760cb70",
    "source_currency": "GHS",
    "name": null,
    "destination_currency": "NGN",
    "chain": null,
    "reference": "HPR-904b551225954a84a0980f5604eabe3c",
    "status": "successful",
    "mode": "test",
    "amount": 647,
    "receive_amount": 65000,
    "total_amount": 647,
    "created_at": "2026-05-04T15:36:05.108827Z",
    "expires_at": null,
    "completed_at": "2026-05-04T15:37:33.807866683Z",
    "rate": 100.46367852,
    "quote_type": "quote",
    "recipient": {
      "type": "spotflow",
      "accountNumber": "3e664e9c-91cd-49b1-8604-a6cc648da705"
    }
  },
  "event": "order.successful"
}

​
Quote Expired

{
  "data": {
    "quote_id": "cadcba83-0ec4-4731-baa1-29c75a61a618",
    "merchant_id": "671ec917-6f90-43f9-86ac-952d60502b10",
    "source_currency": "GHS",
    "name": null,
    "destination_currency": "NGN",
    "chain": null,
    "reference": "HPR-f93d95cdb3fc4567adeaf110401372f4",
    "status": "expired",
    "mode": "test",
    "amount": 800000,
    "receive_amount": 81632653.0612,
    "total_amount": 800000,
    "created_at": "2026-05-04T15:09:04.839059Z",
    "expires_at": "2026-05-04T15:25:51.984171234Z",
    "rate": 0.0098,
    "quote_type": "express"
  },
  "event": "quote.expired"
}