TransactionModel
Represents the full dataset of a transaction.
Fields
idstring uuid requiredThe transaction identifier generated by Ozow.
max length50createdDatestringThe date and time the transaction was created, in South African Standard Time (UTC+2). The value carries a +00:00 offset, which does not describe it. createdDateUtc carries the same instant in UTC and is the field to compute with.
createdDateUtcstring requiredThe UTC date and time the transaction was created. The offset is always +00:00.
siteCodestring requiredThe 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 length50siteNamestring requiredMerchant site name.
max length50bankFromNamestringhe bank the payment has been made from.
max length50bankToNamestringhe bank the payment has been made to.
max length50amountnumber double requiredThe transaction amount. The amount is in the currency specified by the currency codeISO 4217 The three-letter currency codes, such as
ZARfor the South African rand. Always uppercase.Wikipedia posted.statusstring requiredThe transaction status. Possible values are:
- Complete - The payment was successful.
- Cancelled - The payment was cancelled.
- Error - An error occurred while processing the payment.
- Abandoned – The payment was abandoned.
- PendingInvestigation – An inconclusive result was received by the bank and the payment needs to be verified manually.
- 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 length50toAccountstringhe account number.
max length50toReferencestringThe bank reference that was used to make the payment.
max length50paymentDatestring nullableThe date and time the payment completed, in South African Standard Time (UTC+2), or null where no payment has completed. The value carries a +00:00 offset, which does not describe it.
paymentDateUtcstring nullableThe UTC date and time the payment completed, or null where no payment has completed. The offset is always +00:00.
transactionReferencestring requiredThe merchant's transaction reference sent in the request post's TransactionReference variable.
max length50customerstringCustomer’s name
max length50optional1stringOptional fields sent in the request post.
max length50optional2stringOptional fields sent in the request post.
max length50optional3stringOptional fields sent in the request post.
max length50optional4stringOptional fields sent in the request post.
max length50optional5stringOptional fields sent in the request post.
max length50lastEventstring requiredUsed for administration purposes, will be empty for most merchants.
max length50lastEventStatusstringUsed for administration purposes, will be empty for most merchants.
max length50