Inheritance diagram for AmountFinalizedNotification:

Public Member Functions
CommerceTrigger	generateResponse ()

String	getName ()

String	getCurrency ()

void	setCurrency (@NonNull String currency)

BigDecimal	getInitialAmount ()

void	setInitialAmount (@NonNull BigDecimal initialAmount)

BigDecimal	getAdjustedAmount ()

void	setAdjustedAmount (@Nullable BigDecimal adjustedAmount)

BigDecimal	getGratuityAmount ()

void	setGratuityAmount (@Nullable BigDecimal gratuityAmount)

BigDecimal	getFinalAmount ()

void	setFinalAmount (@NonNull BigDecimal finalAmount)

BigDecimal	getAlreadyApprovedAmount ()

void	setAlreadyApprovedAmount (@Nullable BigDecimal alreadyApprovedAmount)

Public Member Functions inherited from CommerceTrigger
String	getMerchantId ()

String	getTerminalId ()

Transaction	getTransaction ()

void	setTransaction (Transaction transaction)

CommerceTrigger	generateResponse ()

String	getMessageType ()

Public Member Functions inherited from CommerceMessage
abstract String	getName ()

abstract String	getMessageType ()

final String	getHandle ()

final boolean	isTypeOfMessage (@NonNull final String type)

boolean	put (String key, Object value)

Object	get (String key)

List< String >	getKeys ()

Status	send (@NonNull final Context context)

Static Public Attributes
static final String	NAME = "CP_SYSTEM_NOTIFIES_AMOUNT_FINALIZED"

Static Public Attributes inherited from CommerceTrigger
static final String	MESSAGE_NAME_PREFIX = "CP_SYSTEM_"

static final String	INTENT_EXTRA_TRANSACTION_CONTEXT = "com.verifone.commerce.intent.extra.TRANSACTION_CONTEXT"

Static Public Attributes inherited from CommerceMessage
static final String	MESSAGE_TYPE_INTERAPP = "INTERAPP"

static final String	MESSAGE_TYPE_PAYMENTTRIGGER = "PAYMENTTRIGGER"

static final String	MESSAGE_TYPE_NONPAYMENTTRIGGER = "NONPAYMENTTRIGGER"

static final String	MESSAGE_TYPE_PAYMENTAPI = "PAYMENTAPI"

static final String	MESSAGE_TYPE_UNKNOWN = "UNKNOWN"

static final String	INTENT_ACTION_PREFIX = "com.verifone.commerce.intent.action."

static final String	INTENT_CATEGORY = "com.verifone.commerce.intent.category.CP_MESSAGE"

static final String	INTENT_EXTRA_HANDLE = "com.verifone.commerce.intent.extra.HANDLE"

static final String	INTENT_EXTRA_PAYLOAD = "com.verifone.commerce.intent.extra.PAYLOAD"

static final String	CP_JSON_KEY_TRANS_AMOUNT = "Trans_Amount"

static final String	CP_JSON_KEY_CURRENCY = "Currency"

Protected Member Functions
void	populateMessageFromJson (@NonNull JSONObject jsonObject)

String	getAsJsonString ()

Protected Member Functions inherited from CommerceTrigger
void	populateMessageFromJson (@NonNull final JSONObject jsonObject)

String	getAsJsonString ()

Protected Member Functions inherited from CommerceMessage
void	populateMessageFromJson (@NonNull final JSONObject jsonObject)

void	setHandle (@NonNull final String handle)

JSONObject	getJsonObject ()

void	setJsonObject (@NonNull final JSONObject jsonObject)

abstract String	getAsJsonString ()

String	getCpAppId ()

void	setCpAppId (String cpAppId)

String	getCpAppVersion ()

void	setCpAppVersion (String cpAppVersion)

Additional Inherited Members
Static Public Member Functions inherited from CommerceMessage
static Intent	createIntentWithName (final String name)

static Intent	createIntentForMessage (final CommerceMessage message)

static int	getNumberOfReceivers (Context context, final CommerceMessage message)

static boolean	isResponseMessage (String name)

static boolean	isRequestMessage (String name)

static boolean	isMessageFromCPAndroid (String name)

Detailed Description

Fired by Payment Application when amount was received from POS or entered directly. This informs the Commerce Applications on the final amount and intermediate amounts, if any.

Definition at line 20 of file AmountFinalizedNotification.java.

Member Function Documentation

◆ generateResponse()

CommerceTrigger generateResponse ( )

There is no response for this object, so this returns null.

Definition at line 34 of file AmountFinalizedNotification.java.

◆ getAdjustedAmount()

BigDecimal getAdjustedAmount ( )

This amount may either be positive or negative.or zero. String amount formatting applies. This represents the sum of adjustments that have to be applied to the initial amount excluding the gratuity. The adjustements may be done by POS or by CP applications. The value may therefore change throughout the transaction.

Definition at line 82 of file AmountFinalizedNotification.java.

◆ getAlreadyApprovedAmount()

BigDecimal getAlreadyApprovedAmount ( )

In case of split tender this field holds the value that was approved in previous iterations.

Definition at line 131 of file AmountFinalizedNotification.java.

◆ getCurrency()

String getCurrency ( )

Alphabetic currency code (ISO 4217). Ex: USD, EUR.

<color="orange">Note: NonNull based on CP contract, be careful to use it before parsing JSON</color>

Definition at line 49 of file AmountFinalizedNotification.java.

◆ getFinalAmount()

BigDecimal getFinalAmount ( )

This represent the projected final amount to be paid. The value may therefore change throughout the transaction. It always obeys to the following formula:

Final_Amount = Initial_Amount + Adjusted_Amount + Gratuity_Amount - Already_Approved_Amount

The value of Final_Amount is used as initial "Trans_Amount" value for the payment phase.

Definition at line 116 of file AmountFinalizedNotification.java.

◆ getGratuityAmount()

BigDecimal getGratuityAmount ( )

This amount is always positive. String amount formatting applies. This represents the tip and its value is constant throughout the transaction.

Definition at line 97 of file AmountFinalizedNotification.java.

◆ getInitialAmount()

BigDecimal getInitialAmount ( )

This number is always positive and non-zero. String amount formatting applies. This represents the amount that payment is attempted. This is either captured by the payment application or by POS. It does not include the gratuity.

Definition at line 65 of file AmountFinalizedNotification.java.