Ozow Hub

Get Transaction

GEThttps://api.ozow.com/GetTransactionProduction
Build with AI 1 package

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.

  • 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

This method is called when you want to query a transaction using Ozow's transaction.

Authentication

Query parameters

  • siteCode string required

    A unique code for the each of the merchant's sites. A site codeSite code The unique code for a site registered under a merchant. A site is a place to transact: a website, or a branch of a store. A merchant can have several, and each transaction names the one it belongs to, so sending the wrong code files the payment against the wrong place. is generated when adding a site in the Ozow merchant admin section.

    max length50
    exampleTST-MER-001
  • transactionId string required

    Ozow's reference for the transaction. This is passed back to the merchant in the redirectRedirect Sending the payer to the Ozow payment page to complete the payment, and returning them to your site afterwards. The alternative is embedding the checkout in your own page, where the payer never leaves it. and notification responses.

    max length50
    example33857766-f29a-4a3a-a37e-66db3c42e439

Request body

Responses

200 Single transaction object
  • transactionId string required

    Ozow's unique reference for the transaction.

    max length50
  • merchantCode string required

    Unique code assigned to each merchant.

    max length50
  • siteCode string required

    The site codeSite code The unique code for a site registered under a merchant. A site is a place to transact: a website, or a branch of a store. A merchant can have several, and each transaction names the one it belongs to, so sending the wrong code files the payment against the wrong place. sent to Ozow in the request post.

    max length50
  • transactionReference string required

    The merchant's transaction reference sent in the request post's TransactionReference variable.

    max length50
  • currencyCode string required

    The transaction currency codeISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia sent in the request post.

    max length3
  • amount number double required

    The transaction amount. The amount is in the currency specified by the currency codeISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia posted.

  • status string required

    The transaction status. Possible values are:

    1. Complete - The payment was successful.
    2. Cancelled - The payment was cancelled.
    3. Error - An error occurred while processing the payment.
    4. Abandoned – The payment was abandoned.
    5. PendingInvestigation – An inconclusive result was received by the bank and the payment needs to be verified manually.
    6. Pending – The status cannot be determined as yet but will be reposted to the notification URLWebhook A URL of yours that Ozow calls when something happens, rather than you polling to find out. The call carries no credential of yours and arrives at a public URL, so authenticate it before acting on it: a hash field on the Payments API, a Svix signature on One API. as soon as it has been determined. Merchants not using the notification URL will receive a PendingInvestigation status.
    max length50
  • statusMessage string

    Message regarding the status of the transaction. This field will not always have a value. This is a user friendly message that can be displayed to the user e.g. User cancelled transaction.

    max length150
  • createdDate string required

    Transaction created date and time.

  • paymentDate string

    Transaction payment date and time.

  • subStatus string

    The transaction sub status for failed transactions. The value provides an indication as to why the payment failed.

    Some examples: • Unclassified – Failure scenario has not been mapped • InsufficientFunds - User did not have sufficient funds available to complete the payment

    While there are several sub-statuses, they have not been included here as they are strictly for reporting.

    max length50
  • bankName string

    The name of the bank the payment was made from.

    max length50
  • maskedAccountNumber string

    The masked account number the payment was made from.

    If account number is 12 or more digits then the first and last four digits are unmasked e.g. 1234567898765 will be masked as 1234*****8765

    If the account number is less than12 digits then the first and last 3 digits are left unmasked e.g. 123456789 will be masked as 123***789

    This is not available by default and a request by the merchant must be submitted along with a justification for requiring this information.

    max length50
  • smartIndicators string

    Some Ozow merchants have requested this information as they use this in their own processes. The can be ignored unless you have a purpose and application for this information. The application of these indicators are for the merchant’s discretion and in isolation do not constitute any action to be taken by the merchant.

    The field will contain a pipe delimited list of the following values if they are applicable e.g. HIGH_VALUE | FIRST_OZOW :

    • HIGH_VALUE – If a soft limit is configured on the site and the amount paid is higher or equal to the configured limit
    • FIRST_OZOW – First time a user has paid using Ozow
    • FIRST_MERCHANT – First time a user has paid the merchant using Ozow
    • NEW_OZOW – User has paid using Ozow for the first time in the past seven days
    • NEW_MERCHANT - User has paid the merchant using Ozow for the first time in the past seven days
    max length500patternHIGH_VALUE|FIRST_OZOW

Guides