Appendix 1 — Supported API methods
This appendix lists every method in the Payment Device SDK and indicates whether it is supported on SmartPOS / Axium integrations.
For the authoritative method reference, open
doc/index.htmlfrom the SDK ZIP — the bundled API documentation is generated directly from the SDK source and stays in sync with each release.
Supported SmartPOS API Methods
| API Method | Supported | Notes |
|---|---|---|
initialize | Yes | Requires ParameterKeys.IsSmartPosIntegration = TRUE. |
setProperties | Yes | — |
connectAndConfigure | Yes | — |
getAvailableCurrencies | Yes | Supports GBP and USD. |
getAvailablePinPads | Yes | Returns only Axium devices when SmartPOS is enabled. |
getStatus | Yes | Requires an active connection to the Axium for the full parameter set. |
getTransactionInformation | Yes | Requires an active connection to the Axium. |
getMerchantData | No | — |
requestTmsUpdate | Yes | — |
disconnect | Yes | — |
dispose | Yes | — |
startTransaction | Yes | See Transaction flow for required, disallowed, and SmartPOS-specific parameters. |
continueDeferredAuthorization | No | Use ParameterKeys.TransactionAuthPreference on startTransaction instead. |
continueForcedAcceptance | No | — |
continuePartialApproval | Yes | Requires ParameterKeys.PartialApproval = True on startTransaction. |
continueSignatureVerification | Yes | Supported from SDK 5.3.1 onwards via the external signature verification flow. |
continueVoiceReferral | No | — |
continueSignatureCapture | No | Signature capture is performed on the Axium device. |
continueApplicationSelection | No | — |
confirmTransaction | Yes | Requires an active connection to the Axium. |
voidTransaction | Yes | Requires an active connection to the Axium. |
linkedRefundTransaction | Yes | Requires an active connection to the Axium. |
getCardDetails | Yes | — |
terminateTransaction | Yes | See Device disconnection for behaviour during a disconnect. |
processReceipt | No | — |
setIdleMessage | No | — |
deleteFailedOfflineRequest | No | — |
retryFailedOfflineRequest | No | — |
processOfflineRequest | Yes | See Offline transactions. |
Calling an unsupported method on a SmartPOS integration will return an error. If your integration shares code between SmartPOS and non-SmartPOS code paths, branch on
getStatus()or your own integration-mode flag before invoking any method marked No above.
Updated 2 months ago
What’s Next
Did this page help you?