> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hifi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Onramp Events

> You can expect to receive webhook events whenever an onramp transfer is created or its status is updated.

## Types

### System Statuses

| Status                            | Description                                       |
| :-------------------------------- | :------------------------------------------------ |
| **ONRAMP.TRANSACTION.CREATED**    | Onramp request created successfully               |
| **ONRAMP.STATUS.NOT\_INITIATED**  | Transaction not initiated due to validation error |
| **ONRAMP.STATUS.OPEN\_QUOTE**     | Quote generated and awaiting deposit              |
| **ONRAMP.STATUS.IN\_REVIEW**      | Transaction under review by monitoring systems    |
| **ONRAMP.STATUS.QUOTE\_FAILED**   | Quote expired before deposit was received         |
| **ONRAMP.STATUS.AWAITING\_FUNDS** | Waiting for fiat deposit with reference ID        |

### Fiat Processing Phase

| Status                            | Description                                                                            |
| :-------------------------------- | :------------------------------------------------------------------------------------- |
| **ONRAMP.STATUS.FIAT\_INITIATED** | Deposit detected, fiat processing started                                              |
| **ONRAMP.STATUS.FIAT\_PENDING**   | Fiat clearing and validation in progress                                               |
| **ONRAMP.STATUS.FIAT\_PROCESSED** | Fiat successfully received and validated                                               |
| **ONRAMP.STATUS.FIAT\_FAILED**    | Fiat processing failed (e.g., invalid amount, missing reference, complaince rejection) |
| **ONRAMP.STATUS.FIAT\_RETURNED**  | Fiat returned to sender after failure                                                  |

### Crypto Processing Phase

| Status                              | Description                                           |
| :---------------------------------- | :---------------------------------------------------- |
| **ONRAMP.STATUS.CRYPTO\_INITIATED** | Converting fiat to stablecoins                        |
| **ONRAMP.STATUS.CRYPTO\_PENDING**   | Sending stablecoins on blockchain                     |
| **ONRAMP.STATUS.CRYPTO\_FAILED**    | Blockchain transaction failed                         |
| **ONRAMP.STATUS.COMPLETED**         | Stablecoins delivered to wallet, transaction complete |

### RFI Events

| Status                | Description                                                                                                           |
| :-------------------- | :-------------------------------------------------------------------------------------------------------------------- |
| **ONRAMP.RFI.OPEN**   | An RFI case has been opened for this transaction. An email with next steps has been sent by the HIFI Compliance team. |
| **ONRAMP.RFI.CLOSED** | The 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.

<Warning>
  Legacy event types will be deprecated on Friday, February 13, 2026.
</Warning>

## Data

The data object is expected to have the same structure as the response from the [Retrieve an onramp endpoint](https://docs.hifi.com/api-reference/onramp/retrieve-an-onramp)

```json theme={null}
{
  "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"
}
```