# Inbound message regarding the ramp status

When a ramp transitions into a new status, the status update will be sent to the provided callback endpoint to your server.

Endpoint: POST rampMessage
Version: 0 BETA

## Request fields (application/json):

  - `order_id` (string, required)
    The ID of the ramp, returned on creation of a ramp, or via the GET ramp endpoint.
    Example: "fd04c5780062121628e05324003eef30"

  - `status` (string, required)
    | Status                 | Description                                                          |
|------------------------|----------------------------------------------------------------------|
| IN_PROGRESS            | Order is in progress. |
| REFUNDED               | Order has been refunded                                              |
| EXPIRED                | Order has expired.                                                   |
| FULFILLED              | Order has been completed.                                            |
| EXTRA_VERIFICATION     | Customer requires extra verification.                                |
| COIN_DEPOSIT_READY     | Coin deposit is ready.                                               |
| COIN_DEPOSIT_CONFIRMED | Coin deposit has been confirmed.                                     |
| COIN_TRANSFERRED       | Coin has been transferred.                                           |
| FIAT_TRANSFERRED       | Fiat has been transferred.                                           |
| CUSTOMER_BLACKLISTED   | Customer has been blacklisted, a separate webhook will be sent with the Identity reference of the customer |
| PAYMENT_READY          | Payment is ready to be processed.                                    |
| PAYMENT_ACCEPTED       | Payment has been accepted for the order                              |
| PAYMENT_RECEIVED       | Payment has been received.                                           |
| PAYMENT_DECLINED       | Payment has been declined.                                           |
| PAYMENT_CANCELLED      | Payment has been cancelled.                                          |
    Enum: "IN_PROGRESS", "REFUNDED", "EXPIRED", "FULFILLED", "EXTRA_VERIFICATION", "COIN_DEPOSIT_READY", "COIN_DEPOSIT_CONFIRMED", "COIN_TRANSFERRED", "FIAT_TRANSFERRED", "CUSTOMER_BLACKLISTED", "PAYMENT_READY", "PAYMENT_ACCEPTED", "PAYMENT_RECEIVED", "PAYMENT_DECLINED", "PAYMENT_CANCELLED"

  - `status_date` (string, required)
    The date of the status update
    Example: "2023-06-05 19:53:08"

  - `created_at` (string)
    The date of the status update
    Example: "2023-06-02 14:44:00"

  - `updated_at` (string)
    The date of the status update
    Example: "2023-06-09 13:53:08"

  - `internal_reason` (string, required)
    The internal body for this inbound message containing the reason of the message, this is for internal use.
    Example: "Order is in progress"

  - `external_reason` (string, required)
    The external reason to provide to your customer via your designated messaging channel.
    Example: "Your payment was successfully received. Your order is now being processed."

  - `order_type` (string)
    The transaction type of the ramp
    Enum: "ONRAMP", "OFFRAMP"

  - `crypto_coin` (string)
    The crypto currency requested
    Example: "ETH"

  - `crypto_blockchain` (string)
    The blockchain
    Example: "ETH"

  - `crypto_amount` (string)
    The amount of crypto
    Example: "0.228632"

  - `fiat_currency` (string)
    The requested fiat currency
    Example: "USD"

  - `fiat_amount` (string)
    The amount of fiat
    Example: "100"

  - `asset_price` (string)
    The market rate of the asset (crypto)
    Example: "0.018656"

  - `payment` (string)
    The payment requested
    Example: "100"

  - `processing_fee` (string)
    The processing fee associated to the ramp
    Example: "1.95"

  - `network_fee` (string)
    The network fee associated to the ramp
    Example: "2.33"

  - `usd_exchange_rate` (string)
    Represent the value of 1 unit of the source Fiat in USD
    Example: "1.36"

  - `transaction_hash` (string)
    The transaction hash of the completed ramp
    Example: "0x9401a7173d7bd2ad73e8b798fdc30c83fb0529e6edbad163c549a5ad136407be"


## Response 200 fields