Events

Event request data

For now, LocalRamp only sends webhooks on five events

1. When the customer sends fiat for a buy or payment transaction - buy.fiat_received

2. When LocalRamp sends the crypto equivalent to the wallet address - buy.crypto_sent

3. When a sell transaction is successfully completed - sell.completed

4. When a sell transaction fails - sell.failed

5. When a swap transaction is successfully completed - swap.completed

6. When a coin deposit arrives for a widget sell transaction - sell.initiated

The webhook request body will look like

Buy (Fiat Received)

{
  "event_type": "buy.fiat_received",
  "reference": "myTransactionReference",
  "sent_amount": "12991.32",
  "sender_currency": "NGN"
}

Buy (Crypto Sent)

{
  "event_type": "buy.crypto_sent",
  "reference": "myTransactionReference",
  "received_amount": "0.0116196",
  "receiver_currency": "ETH_ETH",
  "txid": "<txID>"
}

Sell Completed

{
  "event_type": "sell.completed",
  "tx_ext_reference": "myUniqueRef",
  "reference": "SELL_KYZSHIEMOqPg",
  "from_currency": "LTC",
  "to_currency": "NGN",
  "to_amount": "1158.96",
  "type": "widget" //"widget" or "api"
}

Sell Failed

{
  "event_type": "sell.failed",
  "tx_ext_reference": "myUniqueRef",
  "reference": "SELL_KYZSHIEMOqPg",
  "from_currency": "USDT",
  "to_currency": "NGN",
  "to_amount": "1158.96",
  "type": "widget" //"widget" or "api"
}

Swap Completed

{
  "event_type": "swap.completed",
  "reference": "SWAP_ukS6sPUx9sx7V1qE",
  "from_currency": "BNB",
  "to_currency": "USDT",
  "to_amount": "1.98"
}

Sell initiated (coin deposit)

{
    "event_type": "sell.initiated",
    "reference": "SELL_KYZSHIEMOqPg",
    "from_currency": "BTC",
    "to_currency": "GHS",
    "from_amount": "0.1234"
}

If LocalRamp does not get a 2xx response, we'll retry the endpoint every 30 minutes for 2 hours before we give up.