Skip to main content

​
Types

​
System Events

Event TypeDescription
OFFRAMP.TRANSACTION.CREATEDOfframp request created successfully
OFFRAMP.STATUS.NOT_INITIATEDTransaction not initiated due to validation error
OFFRAMP.STATUS.OPEN_QUOTEQuote generated and awaiting acceptance
OFFRAMP.STATUS.IN_REVIEWTransaction under review by monitoring systems
OFFRAMP.STATUS.QUOTE_FAILEDQuote expired or invalid
OFFRAMP.STATUS.AWAITING_FUNDSAwaiting for crypto deposit

​
Crypto Processing Events

StatusDescription
OFFRAMP.STATUS.CRYPTO_INITIATEDConverting stablecoins, blockchain transaction started
OFFRAMP.STATUS.CRYPTO_PENDINGBlockchain transaction awaiting confirmation
OFFRAMP.STATUS.CRYPTO_PROCESSEDStablecoins successfully converted
OFFRAMP.STATUS.CRYPTO_FAILEDBlockchain transaction failed
OFFRAMP.STATUS.CRYPTO_RETURNEDFailed transaction refunded to user’s wallet

​
Fiat Processing Events

StatusDescription
OFFRAMP.STATUS.FIAT_INITIATEDFiat payout process started
OFFRAMP.STATUS.FIAT_PENDINGFiat transaction awaiting settlement
OFFRAMP.STATUS.FIAT_FAILEDFiat transaction failed
OFFRAMP.STATUS.COMPLETEDFiat successfully delivered to bank account

​
RFI Events

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

​
Legacy Types:

  • OFFRAMP.CREATE: Creation for onramps.
  • OFFRAMP.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 offramp endpoint. 
{
  "eventId": "evt_195713eb5185a84f7d",
  "eventCategory": "OFFRAMP",
  "eventType": "OFFRAMP.STATUS.CRYPTO_INITIATED",
  "eventAction": "CRYPTO_INITIATED",
  "data": {
    "transferType": "OFFRAMP",
    "transferDetails": {
      "id": "07f217dc-f196-4835-ba31-21e1360652d3",
      "source": {
        "user": {
          "email": "william.yang@hifibridge.com",
          "lastName": "Yang",
          "firstName": "William",
          "businessName": null
        },
        "chain": "POLYGON",
        "amount": 100,
        "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
        "currency": "usdc",
        "walletAddress": "0xa8A642FBA80749318036C97344fC73aE0B64c608"
      },
      "status": "CRYPTO_INITIATED",
      "receipt": {
        "transactionHash": null
      },
      "createdAt": "2025-03-07T15:34:49.454729+00:00",
      "requestId": "45eac735-e4cb-422d-8b5d-fd40af31fbec",
      "updatedAt": "2025-03-07T15:34:49.454729+00:00",
      "destination": {
        "user": {
          "email": "william.yang@hifibridge.com",
          "lastName": "Yang",
          "firstName": "William",
          "businessName": null
        },
        "amount": 0,
        "userId": "c5a11cdb-2696-4a2e-ac58-3e17fb230288",
        "currency": "usd",
        "accountId": "d45ac419-c460-438e-ba63-6ffb706c9683"
      },
      "developerFee": null,
      "failedReason": null,
      "transactionHash": null,
      "quoteInformation": null
    }
  },
  "createdAt": "2025-03-07T15:34:49.913Z",
  "timestamp": "2025-03-07T15:35:00.318Z",
  "version": "v2"
}