Field tables for Intent API response and error models returned in listener callbacks.
Sale and refund responses use PosTransactionSummary.
| Field | Type | Notes |
|---|
amount | Long | Cents |
otherAmount | Long | Cashback or secondary amount |
currencyCode | PosCurrencyCode | GBP, USD, EUR, PLN, ZAR |
referenceId | String | |
transactionId | String | UUID |
isApproved | Boolean | |
transactionResult | String | For example, approved_confirmed |
rrn | String | |
transactionTime | String | ISO-8601 |
manufacturerSerialNumber | String | Default "" |
clientReferenceId | String | Default "" |
transactionType | PosTransactionType | SALE, REFUND, and so on |
transactionInfo | Map<String, Any>? | |
posData | Map<String, String>? | Includes merchantTransactionId when set |
link | Map<String, String>? | Payment Link metadata |
linkId | String? | Payment Link ID |
Returned by searchTransaction and related lookup operations.
| Field | Type |
|---|
id | String |
ref | String |
amount | Int |
transactionResult | String |
transactionType | String |
approved | Boolean |
createdDate | String |
dateObject | Date? |
transactionInfo | Map<String, Any>? |
isVoidable | Boolean |
isRefundable | Boolean |
Void operations return VoidResponse - there is no isApproved field.
| Field | Type |
|---|
transactionId | String |
transactionResult | String |
responseCode | String |
| Field | Type |
|---|
errorCode | IntentErrorCode |
errorDescription | String |
Helper: IntentError.title() - human title for CODE_CANCELLED, else enum name. See Intent error codes.
| Operation | Model | Success |
|---|
| Sale | PosTransactionSummary | transactionType is SALE or SALE_WITH_CASHBACK and isApproved == true |
| Refund | PosTransactionSummary | transactionType == REFUND and isApproved == true |
| Void | VoidResponse | transactionResult indicates success |
| Rule | Applies to | Behaviour |
|---|
amount > 0 && amount < maxTransactionAmount | Sale, SaleWithCashback | INVALID_AMOUNT via listener |
amount valid (non-zero, below max) | Refund | INVALID_AMOUNT |
transactionId non-empty | Refund, Void | INVALID_TRANSACTION_ID |
TRANSACTION_RESULT_COUNT present and integer | Search | INVALID_LIMIT if bad |
TRANSACTION_AMOUNT numeric if present | Search | INVALID_AMOUNT if bad |
externalPosData values | All maps on IntentConfig | Must be string, number, or boolean |