Skip to main content

​
Types

​
System Statuses

StatusDescription
ONRAMP.TRANSACTION.CREATEDOnramp request created successfully
ONRAMP.STATUS.NOT_INITIATEDTransaction not initiated due to validation error
ONRAMP.STATUS.OPEN_QUOTEQuote generated and awaiting deposit
ONRAMP.STATUS.IN_REVIEWTransaction under review by monitoring systems
ONRAMP.STATUS.QUOTE_FAILEDQuote expired before deposit was received
ONRAMP.STATUS.AWAITING_FUNDSWaiting for fiat deposit with reference ID

​
Fiat Processing Phase

StatusDescription
ONRAMP.STATUS.FIAT_INITIATEDDeposit detected, fiat processing started
ONRAMP.STATUS.FIAT_PENDINGFiat clearing and validation in progress
ONRAMP.STATUS.FIAT_PROCESSEDFiat successfully received and validated
ONRAMP.STATUS.FIAT_FAILEDFiat processing failed (e.g., invalid amount, missing reference, complaince rejection)
ONRAMP.STATUS.FIAT_RETURNEDFiat returned to sender after failure

​
Crypto Processing Phase

StatusDescription
ONRAMP.STATUS.CRYPTO_INITIATEDConverting fiat to stablecoins
ONRAMP.STATUS.CRYPTO_PENDINGSending stablecoins on blockchain
ONRAMP.STATUS.CRYPTO_FAILEDBlockchain transaction failed
ONRAMP.STATUS.COMPLETEDStablecoins delivered to wallet, transaction complete

​
RFI Events

StatusDescription
ONRAMP.RFI.OPENAn RFI case has been opened for this transaction. An email with next steps has been sent by the HIFI Compliance team.
ONRAMP.RFI.CLOSEDThe RFI case for this transaction has been resolved by the HIFI Compliance team.

​
Legacy Types:

  • ONRAMP.CREATE: Creation for onramps.
  • ONRAMP.UPDATE: Updates for onramps.
Legacy event types will be deprecated on Friday, February 13, 2026.

​
Data

The data object is expected to have the same structure as the response from the Retrieve an onramp endpoint 
{
  "eventId": "evt_1957139631552d0e38",
  "eventCategory": "ONRAMP",
  "eventType": "ONRAMP.STATUS.CRYPTO_INITIATED",
  "eventAction": "CRYPTO_INITIATED",
  "data": {
    "transferType": "ONRAMP",
    "transferDetails": {
      "id": "d938f457-5f8f-43d8-9828-134f6112b429",
      "source": {
        "user": {
          "email": "william.yang@hifibridge.com",
          "lastName": "Yang",
          "firstName": "William",
          "businessName": null
        },
        "amount": 1000,
        "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
        "currency": "usd",
        "accountId": null
      },
      "status": "CRYPTO_INITIATED",
      "receipt": {
        "transactionHash": null
      },
      "createdAt": "2025-03-07T15:29:00.746195+00:00",
      "requestId": "d10d4a8a-4b06-463e-8c12-0ef12c81e961",
      "updatedAt": "2025-03-07T15:29:00.991+00:00",
      "destination": {
        "user": {
          "email": "william.yang@hifibridge.com",
          "lastName": "Yang",
          "firstName": "William",
          "businessName": null
        },
        "chain": "POLYGON_AMOY",
        "amount": null,
        "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
        "currency": "usdhifi",
        "walletAddress": null
      },
      "developerFee": null,
      "failedReason": null,
      "quoteInformation": null
    }
  },
  "createdAt": "2025-03-07T15:29:01.235Z",
  "timestamp": "2025-03-07T15:29:21.008Z",
  "version": "v2"
}