Events

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

Event	When it’s sent
`transaction.success`	The transaction was successfully processed and confirmed.
`transaction.failed`	The 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",
    "partner_context": "order-12345",
    "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": "success",
    "provider": "stripe",
    "created_at": "2025-08-26T10:00:00Z"
  }
}

Meta object reference

Field	Type	Description
`version`	string	Webhook format version (currently `1.0`).
`server_time`	integer	Unix timestamp when event was created.
`event`	enum	Event type (`transaction.success`, `transaction.failed`).

Data object reference

Field	Type	Description
`id`	string	Internal event ID.
`provider_transaction_id`	string	ID from the payment provider.
`partner_context`	string \| null	Partner-supplied reconciliation value, or `null` when omitted.
`type`	string	Transaction type (`buy`, `sell`).
`sender_address`	string	Blockchain address of sender.
`recipient_address`	string	Blockchain address of recipient.
`exchange_rate`	string	Fiat-to-crypto rate applied.
`transaction_hash`	string	Blockchain transaction hash.
`provider_fee`	string	Fee charged by provider.
`orki_fee`	string	Our platform fee.
`network_fee`	string	Network (gas) fee.
`fiat_amount`	string	Amount in fiat currency.
`crypto_amount`	string	Amount in crypto.
`fiat_currency`	string	ISO code of fiat currency (e.g. `USD`, `EUR`).
`crypto_currency`	string	Symbol of crypto asset (e.g. `ETH`, `BTC`).
`network`	string	Blockchain network (e.g. `ethereum`, `bitcoin`).
`payment_method`	string	Method used (e.g. `credit_debit_card`, `bank_transfer`).
`status`	string	Transaction status (`pending`, `success`, `failed`).
`provider`	string	Payment provider name.
`created_at`	string	ISO timestamp of creation.

partner_context is included in the data object for transaction webhooks. Store your own transaction or order identifier in this field when creating the transaction; if you omit it, the webhook returns null.

Getting started

Authentication

Integration Guide

Widget Integration

API Integration

Ramp Providers

Supported Assets

Webhooks

Webhook Events

Supported Events

Example Event Payload

Meta object reference

Data object reference

​Webhook Events

​Supported Events

​Example Event Payload

​Meta object reference

​Data object reference

Webhook Events

Supported Events

Example Event Payload

Meta object reference

Data object reference