To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Read-only snapshot of a payment attempt made through an external payment provider such as eWay, including its outcome and provider response codes. Built from a persisted PaymentTransaction entity via the toBean factory method and carried on payment-related events, so app developers read it to find out whether a payment succeeded and to display the provider's response to a user or in a notification.
Properties
| Property | Returns | Description |
|---|---|---|
| amount | BigDecimal | Amount charged in the transaction, in the currency given by getCurrencyCode. |
| authorisationCode | String | Authorisation code returned by the payment provider for a successful transaction. May be null if the transaction was not authorised. |
| createdBy | ExtProfileBean | Profile of the user who initiated the payment, with their full name resolved. |
| createdDate | Date | Date and time the payment transaction was recorded. |
| currencyCode | String | Currency code the amount was charged in. |
| errors | String | Error details returned by the payment provider, if the transaction failed. Null when the transaction succeeded. |
| id | long | Database identifier of the underlying payment transaction record. |
| invoiceDesc | String | Description of the invoice that was submitted to the payment provider for this transaction. |
| invoiceNum | String | Invoice number that was submitted to the payment provider for this transaction. |
| org | OrgData | Organisation that the payment was made against. |
| provider | String | Name of the app that provided the payment gateway integration used for this transaction. |
| responseCode | String | Raw response code returned by the payment provider, used to look up the response message. |
| responseMessage | String | Human readable message returned by the payment provider describing the outcome of the transaction. |
| status | Boolean | Success or failure status of the transaction as returned by the payment provider. True means the payment succeeded. |
| transactionID | String | Identifier assigned to the transaction by the payment provider, used to reconcile it with the provider's own records. |
| uuid | String | Unique identifier generated for this payment operation, used to trace the transaction in logs if it fails. |
| websiteDomain | String | Domain name of the website the payment was made through. |
| websiteTitle | String | Display title of the website the payment was made through. |
Methods
getId() · getCreatedDate() · getCreatedBy() · getOrg() · getWebsiteDomain() · getWebsiteTitle() · getAuthorisationCode() · getResponseCode() · getResponseMessage() · getTransactionID() · getInvoiceNum() · getInvoiceDesc() · getErrors() · getAmount() · getCurrencyCode() · getStatus() · getProvider() · getUuid()
getId()
Returns: long
Database identifier of the underlying payment transaction record.
getCreatedDate()
Returns: Date
Date and time the payment transaction was recorded.
getCreatedBy()
Returns: ExtProfileBean
Profile of the user who initiated the payment, with their full name resolved.
getOrg()
Returns: OrgData
Organisation that the payment was made against.
getWebsiteDomain()
Returns: String
Domain name of the website the payment was made through.
getWebsiteTitle()
Returns: String
Display title of the website the payment was made through.
getAuthorisationCode()
Returns: String
Authorisation code returned by the payment provider for a successful transaction. May be null if the transaction was not authorised.
getResponseCode()
Returns: String
Raw response code returned by the payment provider, used to look up the response message.
getResponseMessage()
Returns: String
Human readable message returned by the payment provider describing the outcome of the transaction.
getTransactionID()
Returns: String
Identifier assigned to the transaction by the payment provider, used to reconcile it with the provider's own records.
getInvoiceNum()
Returns: String
Invoice number that was submitted to the payment provider for this transaction.
getInvoiceDesc()
Returns: String
Description of the invoice that was submitted to the payment provider for this transaction.
getErrors()
Returns: String
Error details returned by the payment provider, if the transaction failed. Null when the transaction succeeded.
getAmount()
Returns: BigDecimal
Amount charged in the transaction, in the currency given by getCurrencyCode.
getCurrencyCode()
Returns: String
Currency code the amount was charged in.
getStatus()
Returns: Boolean
Success or failure status of the transaction as returned by the payment provider. True means the payment succeeded.
getProvider()
Returns: String
Name of the app that provided the payment gateway integration used for this transaction.
getUuid()
Returns: String
Unique identifier generated for this payment operation, used to trace the transaction in logs if it fails.
© 2025 Kademi Ltd