Documentation

Query Parameters

Onibloc will forward every query parameter prefixed with oni_ from the paywall link to the redirect URL (up to 10). It also appends a unique oni_purchase_session_id.

1. Make your app point your customer to:
   https://onibloc.com/paywall/abc123?oni_customer_ref=123&oni_order_id=abc
2. Customer pays.
3. Customer gets redirected to:
   https://your-product.com/private?oni_customer_ref=123&oni_order_id=abc&oni_purchase_session_id=xyz

Event object

When payment is settled, your webhook receives this JSON payload:

{
  "id": "evt_01HR6Y9S8P7E3N6D4Q2A1B0C",
  "type": "payment.settled",
  "created": "2026-04-10T12:34:56.789Z",
  "data": {
    "paywallId": "paywall_abc123",
    "purchaseSessionId": "session_xyz789",
    "invoicePaymentHash": "6f5d...c2a1",
    "amountSats": 2100,
    "payoutStatus": "forwarded",
    "settledAt": "2026-04-10T12:34:55.123Z",
    "forwardedOniQueryParams": [
      { "key": "oni_customer_ref", "value": "123" },
      { "key": "oni_order_id", "value": "abc" }
    ]
  }
}