Skip to main content

​
Webhook Events

We send webhook events whenever important activity happens (for example: transaction updates). Each webhook has two top-level keys:
  • meta — metadata about the event
  • data — details about the transaction

​
Supported Events

EventWhen it’s sent
transaction.pendingA transaction has been created and is awaiting confirmation (payment or blockchain confirmation).
transaction.successThe transaction was successfully processed and confirmed.
transaction.failedThe transaction could not be completed (payment declined, blockchain error, etc.).

​
Example Event Payload

{
  "meta": {
    "version": "1.0",
    "server_time": 1735303290,
    "event": "transaction.success"
  },
  "data": {
    "id": "12345",
    "provider_transaction_id": "abc-789",
    "type": "buy",
    "sender_address": "0x123...",
    "recipient_address": "0x456...",
    "exchange_rate": "1.05",
    "transaction_hash": "0xdeadbeef...",
    "provider_fee": "2.50",
    "orki_fee": "0.50",
    "network_fee": "0.20",
    "fiat_amount": "100.00",
    "crypto_amount": "0.0023",
    "fiat_currency": "USD",
    "crypto_currency": "ETH",
    "network": "ethereum",
    "transaction_method": "card",
    "status": "completed",
    "provider": "stripe",
    "created_at": "2025-08-26T10:00:00Z"
  }
}

​
Meta object reference

FieldTypeDescription
versionstringWebhook format version (currently 1.0).
server_timeintegerUnix timestamp when event was created.
eventenumEvent type (transaction.pending, transaction.success, transaction.failed).

​
Data object reference

FieldTypeDescription
idstringInternal event ID.
provider_transaction_idstringID from the payment provider.
typestringTransaction type (buy, sell).
sender_addressstringBlockchain address of sender.
recipient_addressstringBlockchain address of recipient.
exchange_ratestringFiat-to-crypto rate applied.
transaction_hashstringBlockchain transaction hash.
provider_feestringFee charged by provider.
orki_feestringOur platform fee.
network_feestringNetwork (gas) fee.
fiat_amountstringAmount in fiat currency.
crypto_amountstringAmount in crypto.
fiat_currencystringISO code of fiat currency (e.g. USD, EUR).
crypto_currencystringSymbol of crypto asset (e.g. ETH, BTC).
networkstringBlockchain network (e.g. ethereum, bitcoin).
payment_methodstringMethod used (e.g. credit_debit_card, bank_transfer).
statusstringTransaction status (pending, success, failed).
providerstringPayment provider name.
created_atstringISO timestamp of creation.

​
Supported Events

EventWhen it’s sent
transaction.pendingA transaction has been created and is awaiting confirmation (payment or blockchain confirmation).
transaction.successThe transaction was successfully processed and confirmed.
transaction.failedThe transaction could not be completed (payment declined, blockchain error, etc.).
⌘I