APA POS SDK/com.abrantix.apa.sdk/TransactionStatus

TransactionStatus

enum TransactionStatus : Enum<TransactionStatus>

Current outcome of a transaction, as reported by Terminal.fetchTransactionStatus.

A transaction id the terminal service has no record of is reported as an TerminalException with httpStatus == 404, not as a value of this enum.

Entries

INITIALIZED

A pre-transaction wait (see Terminal.startPreTransaction) started under this id is still running.

IN_PROGRESS

Still ongoing (e.g. waiting for card interaction, online authorisation, or a reversal).

WAITING_FOR_COMMIT

Approved, but the terminal is still waiting for a commit decision (two-phase flow, autoCommit = false) - unlike the other values, this still requires action from the ECR. Use Terminal.resume to get back an UncommittedTransactionResult and call UncommittedTransactionResult.commit/ UncommittedTransactionResult.rollback on it.

WAITING_FOR_COMPLETION

Approved as a reservation, awaiting the final completion/online-advice call.

COMPLETED

Approved (online or offline, immediately or via a reservation) and fully concluded - cannot change state anymore without a new operation.

FAILED

Not completed - declined by the card/host, or aborted by the cardholder/ECR/exception handling.

REVERSED

The transaction has been reversed.

UNKNOWN

The terminal service reported a status this SDK version does not know yet.

Properties

entries

val entries: EnumEntries<TransactionStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): TransactionStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TransactionStatus>

Returns an array containing the constants of this enum type, in the order they're declared.