{"title":"Tender states","category":"default","creationDate":1779706500,"content":"
\n
Looking for payment statuses?<\/h5>

Refer to Payments lifecycle<\/a> for payment statuses like Received, Authorised, or Settled.<\/p><\/div><\/div>\n\n

The tender is the entire process for the POS app to start the transaction, receive payment method information, make optional changes to the amount, await authorization, print the receipt, and receive a final status.<\/p>\n

During the tender, payment terminals generate display notifications<\/a>. You can present these in your POS app to keep your staff up-to-date on the progress of the transaction.<\/p>\n

In the next overviews, the in-progress tender state<\/a> is the current state of the transaction while it is ongoing, and the tender result<\/a> is the state when the transaction is completed.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements.<\/p>\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nA Terminal API integration<\/a> with payment terminals.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

In-progress tender states<\/h2>\n

While the transaction is ongoing, the tender can have the following states.<\/p>\n\n

State<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

\n

ACCOUNT_TYPE_SELECTED<\/p>\n<\/td>

\n

The shopper has selected their preferred account type.<\/p>\n<\/td><\/tr>\n

\n

ACKNOWLEDGED<\/p>\n<\/td>

\n

The transaction is acknowledged, but not approved, declined, cancelled or failed in error.<\/p>\n<\/td><\/tr>\n

\n

ADDITIONAL_DATA_AVAILABLE<\/p>\n<\/td>

\n

Additional data (like card alias (token), card type and issuer country code) are available.<\/p>\n<\/td><\/tr>\n

\n

APPLICATION_SELECTED<\/p>\n<\/td>

\n

The shopper has selected their preferred payment application.<\/p>\n<\/td><\/tr>\n

\n

ASK_CHARITY<\/p>\n<\/td>

\n

The terminal is waiting for a possible donation.<\/p>\n<\/td><\/tr>\n

\n

ASK_DCC<\/p>\n<\/td>

\n

The terminal is checking if the shopper requires dynamic currency conversion.<\/p>\n<\/td><\/tr>\n

\n

ASK_GRATUITY<\/p>\n<\/td>

\n

The terminal is waiting for a possible gratuity.<\/p>\n<\/td><\/tr>\n

\n

ASK_SIGNATURE<\/p>\n<\/td>

\n

The terminal has requested a signature from the shopper.<\/p>\n<\/td><\/tr>\n

\n

BALANCE_QUERY_ACQUIRED<\/p>\n<\/td>

\n

Confirms the acquired balance and allows the user to take next steps.<\/p>\n<\/td><\/tr>\n

\n

BALANCE_QUERY_COMPLETED<\/p>\n<\/td>

\n

The request for card balance has completed.<\/p>\n<\/td><\/tr>\n

\n

BALANCE_QUERY_STARTED<\/p>\n<\/td>

\n

The terminal is requesting the balance on a card.<\/p>\n<\/td><\/tr>\n

\n

CANCEL_OR_REFUND_COMPLETED<\/p>\n<\/td>

\n

The cancellation or refund has completed.<\/p>\n<\/td><\/tr>\n

\n

CARD_ACQ_COMPLETED<\/p>\n<\/td>

\n

The terminal has acquired the card details.<\/p>\n<\/td><\/tr>\n

\n

CARD_DETAILS_PROVIDED<\/p>\n<\/td>

\n

The card details have been entered.<\/p>\n<\/td><\/tr>\n

\n

CARD_INSERTED<\/p>\n<\/td>

\n

A card was inserted.<\/p>\n<\/td><\/tr>\n

\n

CARD_METHOD_SELECTED<\/p>\n<\/td>

\n

A card is presented to the terminal for a contactless\/NFC transaction<\/p>\n<\/td><\/tr>\n

\n

CARD_MKE<\/p>\n<\/td>

\n

The terminal is waiting for card details to be entered using Manual Keyed Entry<\/a> (MKE). This is used as a fall back if chip and magnetic stripe are not working.<\/p>\n<\/td><\/tr>\n

\n

CARD_PRESENTED<\/p>\n<\/td>

\n

The shopper has presented the card to the terminal's contactless reader.<\/p>\n<\/td><\/tr>\n

\n

CARD_REMOVED<\/p>\n<\/td>

\n

A card was removed from the terminal.<\/p>\n<\/td><\/tr>\n

\n

CARD_SWIPED<\/p>\n<\/td>

\n

A card was swiped.<\/p>\n<\/td><\/tr>\n

\n

CHARITY_ENTERED<\/p>\n<\/td>

\n

The shopper responded to the donation prompt.<\/p>\n<\/td><\/tr>\n

\n

CHECK_SIGNATURE<\/p>\n<\/td>

\n

The terminal is waiting for the cashier to approve or decline the signature.<\/p>\n<\/td><\/tr>\n

\n

DCC_ACCEPTED<\/p>\n<\/td>

\n

The shopper accepted Dynamic Currency Conversion.<\/p>\n<\/td><\/tr>\n

\n

DCC_REJECTED<\/p>\n<\/td>

\n

The shopper rejected Dynamic Currency Conversion.<\/p>\n<\/td><\/tr>\n

\n

GRATUITY_ENTERED<\/p>\n<\/td>

\n

The gratuity amount was entered.<\/p>\n<\/td><\/tr>\n

\n

INITIAL<\/p>\n<\/td>

\n

A transaction was initiated.<\/p>\n<\/td><\/tr>\n

\n

LOAD_COMPLETED<\/p>\n<\/td>

\n

Loading a value on the card has completed.<\/p>\n<\/td><\/tr>\n

\n

LOAD_STARTED<\/p>\n<\/td>

\n

Loading a value on the card has started.<\/p>\n<\/td><\/tr>\n

\n

PIN_ENTERED<\/p>\n<\/td>

\n

The whole PIN was entered.<\/p>\n<\/td><\/tr>\n

\n

PRINT_RECEIPT<\/p>\n<\/td>

\n

the terminal is printing the receipt.<\/p>\n<\/td><\/tr>\n

\n

PROCESSING_TENDER<\/p>\n<\/td>

\n

The payment is being processed. The terminal shows a progress bar.<\/p>\n<\/td><\/tr>\n

\n

PROVIDE_CARD_DETAILS<\/p>\n<\/td>

\n

The terminal is waiting for card details.<\/p>\n<\/td><\/tr>\n

\n

RECEIPT_PRINTED<\/p>\n<\/td>

\n

A receipt was printed.<\/p>\n<\/td><\/tr>\n

\n

REFERRAL<\/p>\n<\/td>

\n

The acquirer sends a referral status.<\/p>\n<\/td><\/tr>\n

\n

REFERRAL_CHECKED<\/p>\n<\/td>

\n

The referral code was checked.<\/p>\n<\/td><\/tr>\n

\n

SIGNATURE_CHECKED<\/p>\n<\/td>

\n

The cashier has checked and confirmed the signature.<\/p>\n<\/td><\/tr>\n

\n

TENDER_CREATED<\/p>\n<\/td>

\n

The tender was created successfully.<\/p>\n<\/td><\/tr>\n

\n

TENDER_FINAL<\/p>\n<\/td>

\n

The tender was completed.<\/p>\n<\/td><\/tr>\n

\n

WAIT_FOR_ACCOUNT_TYPE_SELECTION<\/p>\n<\/td>

\n

The terminal is waiting for the shopper to select an account type.<\/p>\n<\/td><\/tr>\n

\n

WAIT_FOR_AMOUNT_ADJUSTMENT<\/p>\n<\/td>

\n

Waiting for an amount to be adjusted based on the gratuity.<\/p>\n<\/td><\/tr>\n

\n

WAIT_FOR_APP_SELECTION<\/p>\n<\/td>

\n

The terminal is waiting for the shopper to select a payment application.<\/p>\n<\/td><\/tr>\n

\n

WAIT_FOR_PIN<\/p>\n<\/td>

\n

A PIN is requested at the terminal.<\/p>\n<\/td><\/tr>\n<\/tbody><\/table>\n

Tender result<\/h2>\n

When the transaction is completed, the tender can have the following states.<\/p>\n\n
State<\/th>Description<\/th><\/tr><\/thead>
APPROVED<\/td>The transaction was approved.<\/td><\/tr>\n
CANCELLED<\/td>The transaction was cancelled.<\/td><\/tr>\n
DECLINED<\/td>The transaction was declined.<\/td><\/tr>\n
ERROR<\/td>The transaction did not go through because an error occurred.<\/td><\/tr>\n<\/tbody><\/table>\n

See also<\/h2>\n