Determine the current and final tender state

Use the following methods to retrieve the current or final state of a tender.

The pos_result_code visible in your logs refers to the result of communication between the library and the PED and does not represent the final state of a transaction.

Method

Name	Description
`GetTenderState`	Returns the current state result code. The first status to be checked during the transaction. If the tender state is not `OK`, something went wrong.

Object

Name	Description
`finalObj`	Run `GetFinalStateCode` against this object to get the final state of the transaction. Do this after the final transaction callback.

Method

Name	Description
`GetResponseHeader`	Return the response header of the final object.

GetResponseHeader returns:

Object

Name	Description
`ResponseHdr`	Run `GetFinalStateCode` against this object to get the final state of the transaction. Do this after the final transaction callback

Method

Name	Description
`GetTenderState`	Apply this to the response header of the final callback to return the final state of the transaction.

In-progress tender states

State	Description
ACCOUNT_TYPE_SELECTED	The shopper has selected their preferred account type.
ACKNOWLEDGED	The transaction is acknowledged, but not approved, declined, cancelled or failed in error.
ADDITIONAL_DATA_AVAILABLE	Additional data (like card alias (token), card type and issuer country code) are available.
APPLICATION_SELECTED	The shopper has selected their preferred payment application.
ASK_CHARITY	The terminal is waiting for a possible donation.
ASK_DCC	The terminal is checking if the shopper requires dynamic currency conversion.
ASK_GRATUITY	The terminal is waiting for a possible gratuity.
ASK_SIGNATURE	The terminal has requested a signature from the shopper.
BALANCE_QUERY_ACQUIRED	Confirms the acquired balance and allows the user to take next steps.
BALANCE_QUERY_COMPLETED	The request for card balance has completed.
BALANCE_QUERY_STARTED	The terminal is requesting the balance on a card.
CANCEL_OR_REFUND_COMPLETED	The cancellation or refund has completed.
CARD_ACQ_COMPLETED	The terminal has acquired the card details.
CARD_DETAILS_PROVIDED	The card details have been entered.
CARD_INSERTED	A card was inserted.
CARD_METHOD_SELECTED	A card is presented to the terminal for a contactless/NFC transaction
CARD_MKE	The terminal is waiting for card details to be entered using Manual Keyed Entry (MKE). This is used as a fall back if chip and magnetic stripe are not working.
CARD_PRESENTED	The shopper has presented the card to the terminal's contactless reader.
CARD_REMOVED	A card was removed from the terminal.
CARD_SWIPED	A card was swiped.
CHARITY_ENTERED	The shopper responded to the donation prompt.
CHECK_SIGNATURE	The terminal is waiting for the cashier to approve or decline the signature.
DCC_ACCEPTED	The shopper accepted Dynamic Currency Conversion.
DCC_REJECTED	The shopper rejected Dynamic Currency Conversion.
GRATUITY_ENTERED	The gratuity amount was entered.
INITIAL	A transaction was initiated.
LOAD_COMPLETED	Loading a value on the card has completed.
LOAD_STARTED	Loading a value on the card has started.
PIN_ENTERED	The whole PIN was entered.
PRINT_RECEIPT	he terminal is printing the receipt.
PROCESSING_TENDER	The payment is being processed. The terminal displays a progress bar.
PROVIDE_CARD_DETAILS	The terminal is waiting for card details.
RECEIPT_PRINTED	A receipt was printed.
REFERRAL	The acquirer sends a referral status.
REFERRAL_CHECKED	The referral code was checked.
SIGNATURE_CHECKED	The cashier has checked and confirmed the signature.
TENDER_CREATED	The tender was created successfully.
TENDER_FINAL	The tender was completed.
WAIT_FOR_ACCOUNT_TYPE_SELECTION	The terminal is waiting for the shopper to select an account type.
WAIT_FOR_AMOUNT_ADJUSTMENT	Waiting for an amount to be adjusted based on the gratuity.
WAIT_FOR_APP_SELECTION	The terminal is waiting for the shopper to select a payment application.
WAIT_FOR_PIN	A PIN is requested at the terminal.

Tender result

State	Description
APPROVED	The transaction was approved.
CANCELLED	The transaction was cancelled.
DECLINED	The transaction was declined.
ERROR	The transaction did not go through as an error occurred.
UNKNOWN	Specific to library integrations. The tender state is unknown, and it is not possible to determine it. If you are using the TxStore feature, you can check the transaction result there. If not, you can check the transactions menu on the terminal.