Refund completed · One API

POST Ozow sendsyour notification URL

Build with AI 2 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.

Refund a paymentEverything needed to refund a completed payment through One API, in full or in part, and to handle the statuses a refund moves through.
View package
Migrate refunds from the Payments API to One APIEverything needed to move an existing refunds integration onto One API, with the legacy guide and its One API counterpart side by side.
View package

Raised when a refund reaches a final state. status is Pending, Failed, Complete, Submitted, Cancelled, Returned or Invalid. Pending covers a refund under investigation, and Failed covers both a failure and an error.

A subscription registered as full receives RefundCompleteFullData in data instead, and its Status is the refund's own, unmapped: PendingInvestigation and Error arrive as themselves rather than as Pending and Failed.

Delivered by Svix, with svix-id, svix-timestamp and svix-signature headers. Verify the signature with the webhook's secret before acting on the contents.

Authentication

Ozow sends no credential with this call, so this check is the only thing standing between a real delivery and a stranger’s. Verify the delivery signature before acting on the contents: your notification URL is public, and anyone can post to it.

Payload

application/json

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.

Your response

200 Acknowledged. Return this once you have stored the event.

No body.

Guides

Refund a paymentIssue a refund with One API. Refunds are merchant-initiated backend operations with no customer-facing step, so the whole flow is in your backend.

Notification

POST /your/notification/url HTTP/1.1
Content-Type: application/json

{
  "type": "<type>",
  "timestamp": "2026-01-15T09:30:00Z",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "<status>",
    "reason": "<reason>"
  }
}

Built from the payload schema. Values are placeholders, not real data.

Verify

This notification is signed. Verify the signature with the webhook’s secret before acting on the contents: Verify a webhook signature has the steps and a working implementation.