Ramp Events
Events related to fiat on-ramp and off-ramp operations.
ramp.on_ramp.completed
Triggered when a fiat-to-crypto conversion (on-ramp) is successfully completed.
Available Data
| Field | Type | Description |
|---|---|---|
ramp_id | string | Unique identifier for the ramp operation |
direction | string | Operation direction (on_ramp) |
status | string | Current status of the operation |
service_name | string | Provider name (e.g., brla, blindpay) |
source_currency | string | Fiat currency sent (e.g., BRL, USD) |
target_currency | string | Crypto currency received (e.g., USDC) |
amount | amount | Amount processed |
exchange_rate | numeric | Exchange rate applied |
walletable_id | wallet | ID of the wallet receiving the crypto |
ramp.off_ramp.completed
Triggered when a crypto-to-fiat conversion (off-ramp) is successfully completed.
Available Data
| Field | Type | Description |
|---|---|---|
ramp_id | string | Unique identifier for the ramp operation |
direction | string | Operation direction (off_ramp) |
status | string | Current status of the operation |
service_name | string | Provider name (e.g., brla, blindpay) |
source_currency | string | Crypto currency sent (e.g., USDC) |
target_currency | string | Fiat currency received (e.g., BRL, USD) |
amount | amount | Amount processed |
exchange_rate | numeric | Exchange rate applied |
beneficiary_id | beneficiary | ID of the beneficiary receiving the fiat |
Example Usage
{
"hook_type": "ramp.on_ramp.completed",
"data": {
"amount": "1000.00",
"source_currency": "BRL",
"target_currency": "USDC"
}
}