Ozow Hub
On this page2 sections
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.

  • 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
  • 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

  • SiteCode string required

    The site the transaction was created against.

  • TransactionId string uuid required

    The transaction identifier.

  • TransactionReference string required

    Your own reference for the transaction.

  • Amount string required

    The amount, to two decimal places, with a full stop as the separator.

  • Status string required

    The mapped status, the same four values the thin payload carries.

    values"Successful""Incomplete""Pending""Error"
  • Optional1 string required

    Your first optional field, empty when it was not set.

  • Optional2 string required

    Your second optional field, empty when it was not set.

  • Optional3 string required

    Your third optional field, empty when it was not set.

  • Optional4 string required

    Your fourth optional field, empty when it was not set.

  • Optional5 string required

    Your fifth optional field, empty when it was not set.

  • CurrencyCode string required

    The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia currency code.

  • IsTest string required

    Whether the transaction was a test one.

    values"True""False"
  • StatusMessage string required

    The status detail, empty when there is none.

  • Hash string required

    The check hash over the field set, the same one the Payments API notification carries. Verify the Svix signature rather than this: the signature covers the whole delivery.

  • SubStatus string

    Present only when the transaction has a sub-status.

  • SubStatusDescription string

    Present only when the sub-status has a description.

  • MaskedAccountNumber string

    The payer's masked account number. Present only when your site is configured to receive it and the transaction is complete, pending or under investigation.

  • BankName string

    The payer's bank. Absent when your site is configured for legacy fields only.

  • SmartIndicators string

    The risk indicators. Present only on a complete transaction that has them, and never when your site is configured for legacy fields only.

  • BankId string

    Present only on a live transaction when your site is configured to receive banking details.

  • AccountNumber string

    Present only on a live transaction when your site is configured to receive banking details.

  • PublicRecipientName string

    Present only on a live transaction when your site is configured to receive banking details.

Guides