Ozow Hub

WebhookEnvelope

Every delivery has this shape. `data` is what the subscription's message type decides.

On this page2 sections
Build with AI 5 packages

A build package is every page for one task, with the API operations they use. Copy the prompt into a coding assistant, or hand it the package itself: slim links to each page, full inlines all of them in one document.

Filter
  • Take a paymentEverything needed to take a payment end to end with One API, from credentials through the hosted page to the webhook that confirms it, and the test cases that prove each outcome before you go live.
    View package
  • Take a recurring paymentEverything needed to collect from a customer on a schedule with One API, from the consent the customer gives once through to each collection and the webhook that reports it.
    View package
  • Migrate a payin from the Payments API to One APIEverything needed to move an existing redirect payin onto One API, with the legacy guide and its One API counterpart side by side.
    View package

Fields

  • type string required

    The event type the subscription was created for.

  • timestamp string date-time required

    When the event was raised.

  • data any of required

    What the subscription's message type decides. A thin subscription receives WebhookEventData, which is every event's default and the only form the subscription events support. A full subscription to transaction.complete receives TransactionCompleteFullData, and to refund.complete, RefundCompleteFullData. A full subscription to any of the subscription events receives nothing at all.

Guides