Skip to main content

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

FieldTypeDescription
ramp_idstringUnique identifier for the ramp operation
directionstringOperation direction (on_ramp)
statusstringCurrent status of the operation
service_namestringProvider name (e.g., brla, blindpay)
source_currencystringFiat currency sent (e.g., BRL, USD)
target_currencystringCrypto currency received (e.g., USDC)
amountamountAmount processed
exchange_ratenumericExchange rate applied
walletable_idwalletID of the wallet receiving the crypto

ramp.off_ramp.completed

Triggered when a crypto-to-fiat conversion (off-ramp) is successfully completed.

Available Data

FieldTypeDescription
ramp_idstringUnique identifier for the ramp operation
directionstringOperation direction (off_ramp)
statusstringCurrent status of the operation
service_namestringProvider name (e.g., brla, blindpay)
source_currencystringCrypto currency sent (e.g., USDC)
target_currencystringFiat currency received (e.g., BRL, USD)
amountamountAmount processed
exchange_ratenumericExchange rate applied
beneficiary_idbeneficiaryID of the beneficiary receiving the fiat

Example Usage

{
"hook_type": "ramp.on_ramp.completed",
"data": {
"amount": "1000.00",
"source_currency": "BRL",
"target_currency": "USDC"
}
}