Represents Alt Payment Data object on CP-Payment communication. More...
Represents Barcode object on CP-Payment communication. More...
Customer identification to be used equivalent to a card pre-dip / pre-swipe. More...
Represents the Donation object on CP-Payment communication. More...
Trigger invocation result. More...
Represents LoyaltyIdentifier object on CP-Payment communication. More...
Represents the Merchandise object on CP-Payment communication. More...
Represents the Offer object on CP-Payment communication. More...
Payment amount adjustment Fx data. More...
Represents Alt Payment trigger response. More...
ApiError {
API\_OK, API\_FAIL, API\_SERVICE\_TIMEOUT, API\_INVALID\_PARAMETERS,
API\_UNSUPPORTED\_REQUEST, API\_ENCRYPTION\_UNAVAILABLE, API\_NO\_PAPER
}
ErrorCode {
CP\_INVOKE\_SUCCESS, CP\_INVOKE\_FAILED, CP\_INVOKE\_TIMEOUT, CP\_INVOKE\_MANDATORY\_PARAMS\_MISSING,
CP\_INVOKE\_SERVICE\_SUCCESS, CP\_INVOKE\_NATIVE\_SUCCESS, CP\_INVOKE\_CANCELED, CP\_INVOKE\_BUSY,
CP\_INVOKE\_IDLE, CP\_INVOKE\_NOT\_IMPLEMENTED
}
Represents possible error codes of invoke call. More...
OFFER\_TYPE {
OFFER\_UNDEFINED, OFFER\_MERCHANT\_COUPON, OFFER\_MANUFACTURER\_COUPON, OFFER\_OTHER\_COUPON,
OFFER\_PRODUCT\_DISCOUNT, OFFER\_LOYALTY\_CARD, OFFER\_TRANSACTION\_DISCOUNT
}
Represents the Offer object on CP-Payment communication. More...
CpTrigger {
NOTIF\_IDLE = 0, NOTIF\_MANUAL\_LAUNCH = 1, REQUEST\_CUSTOMER\_IDENTIFICATION = 16, NOTIF\_TRX\_STARTED = 2,
REQUEST\_BASKET\_ADJUSTMENT = 3, NOTIF\_BASKET\_FINALIZED = 4, REQUEST\_LOYALTY = 5, REQUEST\_AMOUNT\_ADJUSTMENT = 6,
NOTIF\_AMOUNT\_FINALIZED = 7, REQUEST\_ALT\_PAYMENT = 8, REQUEST\_TECH\_ALT\_PAYMENT = 17, NOTIF\_CARD\_PRESENTED = 9,
NOTIF\_CARD\_BIN\_RECEIVED = 10, REQUEST\_PAYMENT\_AMOUNT\_ADJUSTMENT = 11, NOTIF\_AUTHORIZATION\_COMPLETED = 12, NOTIF\_PAYMENT\_COMPLETED = 13,
REQUEST\_RECEIPT\_MANAGEMENT = 14, NOTIF\_TRX\_ENDED = 15
}
CpTrigger - contains all triggers used by commerce platform. More...
TransactionType {
TRX\_TYPE\_MIN\_VALUE = -1, TRX\_TYPE\_UNDEFINED = 0, TRX\_TYPE\_PAYMENT, TRX\_TYPE\_DEFERRED\_PAYMENT,
TRX\_TYPE\_DEFERRED\_PAYMENT\_COMPLETION, TRX\_TYPE\_REFUND, TRX\_TYPE\_VOID, TRX\_TYPE\_PRE\_AUTHORISATION,
TRX\_TYPE\_PRE\_AUTHORISATION\_COMPLETION, TRX\_TYPE\_CASH\_ADVANCE, TRX\_TYPE\_CASHBACK, TRX\_TYPE\_CASH\_PAYMENT,
TRX\_TYPE\_REVERSAL
}
CardType {
CARD\_TYPE\_MIN\_VALUE = -1, CARD\_TYPE\_UNDEFINED = 0, CARD\_TYPE\_MAG\_STRIPE, CARD\_TYPE\_CHIP,
CARD\_TYPE\_CTLS\_CARD, CARD\_TYPE\_CTLS\_PHONE, CARD\_TYPE\_MANUAL
}
AuthEntity {
AUTH\_ENTITY\_MIN\_VALUE = -1, AUTH\_ENTITY\_UNDEFINED = 0, AUTH\_ENTITY\_MERCHANT, AUTH\_ENTITY\_ACQUIRER,
AUTH\_ENTITY\_CARD\_SCHEME, AUTH\_ENTITY\_ISSUER
}
AuthResult {
AUTH\_RESULT\_MIN\_VALUE = -1, AUTH\_RESULT\_UNDEFINED = 0, AUTH\_RESULT\_AUTHORIZED\_ONLINE, AUTH\_RESULT\_AUTHORIZED\_OFFLINE,
AUTH\_RESULT\_REJECTED\_ONLINE, AUTH\_RESULT\_CASH\_VERIFIED, AUTH\_RESULT\_ABORTED
}
HolderAuth {
HOLDER\_AUTH\_MIN\_VALUE = -1, HOLDER\_AUTH\_UNDEFINED = 0, HOLDER\_AUTH\_PIN, HOLDER\_AUTH\_SIGNATURE,
HOLDER\_AUTH\_ID, HOLDER\_AUTH\_OTHER, HOLDER\_AUTH\_NONE
}
TechnologyType {
TECH\_TYPE\_MIN\_VALUE = -1, TECH\_TYPE\_UNDEFINED = 0, TECH\_TYPE\_MIFARE\_CLASSIC, TECH\_TYPE\_MIFARE\_ULTRALIGHT,
TECH\_TYPE\_ISO7816
}
Only filled if manualEntry is true.
Possible values are
ZIP prompts to enter zipcode
NOCVV disables prompt for CVV
If ZIP is specified, the result of the AVS is returned in AVS\_Code
| | string | panHandle | reference of payment application ehich refers to the PAN in question. | | string | result | result of transaction | | string | transactionAmount | amount of transaction | | string | transactionId | transaction id provided by the payment gateway, which is a client specific transaction identifier. | | string | transactionType | type of transaction executed by the payment application | ### EnumerationType Documentation ### ApiError enum \[ApiError]\(#a6aec14d1e03f2a2bf43eeae11b6a0ca4) | | | | ---------------------------- | - | | Enumerator | | | API\_OK | | | API\_FAIL | | | API\_SERVICE\_TIMEOUT | | | API\_INVALID\_PARAMETERS | | | API\_UNSUPPORTED\_REQUEST | | | API\_ENCRYPTION\_UNAVAILABLE | | | API\_NO\_PAPER | | ### AuthEntity enum \[AuthEntity]\(#abf880d7292973573c80d9fd18ea77453) Entity that has authorized the transaction. | | | | -------------------------- | ------------------------------------------------- | | Enumerator | | | AUTH\_ENTITY\_MIN\_VALUE | min value of enumeration | | AUTH\_ENTITY\_UNDEFINED | entity is undefined | | AUTH\_ENTITY\_MERCHANT | merchant has authorized the transaction | | AUTH\_ENTITY\_ACQUIRER | acquirer has authorized the transaction | | AUTH\_ENTITY\_CARD\_SCHEME | card scheme used for authorization of transaction | | AUTH\_ENTITY\_ISSUER | issuer has authorized the transaction | ### AuthResult enum \[AuthResult]\(#a87ba9bd5edfd749f4729620dbadd5fce) Result of transaction authorization. | | | | --------------------------------- | ----------------------------------- | | Enumerator | | | AUTH\_RESULT\_MIN\_VALUE | min value of enumeration | | AUTH\_RESULT\_UNDEFINED | result is undefined | | AUTH\_RESULT\_AUTHORIZED\_ONLINE | online authorized | | AUTH\_RESULT\_AUTHORIZED\_OFFLINE | offline authorized | | AUTH\_RESULT\_REJECTED\_ONLINE | online rejected | | AUTH\_RESULT\_CASH\_VERIFIED | transaction verified and cash payed | | AUTH\_RESULT\_ABORTED | authorization aborted | ### CardType enum \[CardType]\(#a76b9e96d86b331202dcc0fba38b758cd) Specifies card type used to obtain card data. | | | | ----------------------- | ---------------------------- | | Enumerator | | | CARD\_TYPE\_MIN\_VALUE | min value of enumeration | | CARD\_TYPE\_UNDEFINED | card type is undefined | | CARD\_TYPE\_MAG\_STRIPE | used card type is mag-stripe | | CARD\_TYPE\_CHIP | used card type is chip | | CARD\_TYPE\_CTLS\_CARD | used card type is ctls card | | CARD\_TYPE\_CTLS\_PHONE | used card type is ctls phone | | CARD\_TYPE\_MANUAL | used card type is manual | ### CpTrigger enum \[CpTrigger]\(#aba55b083790f62440bcff1c23bbe2f12) CpTrigger - contains all triggers used by commerce platform. | | | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | NOTIF\_IDLE |CP\_SYSTEM\_NOTIFIES\_IDLE\_ENTERED - Fired by Payment Application when entering idle state. This happens once when application first starts up and each time after a transaction completes.
This allows the Commerce Applications to control the screen and devices in-between transactions.
| | NOTIF\_MANUAL\_LAUNCH | CP\_SYSTEM\_NOTIFIES\_MANUAL\_LAUNCH\_SELECTED - Fired by Payment application when one of the service label has been selected. | | REQUEST\_CUSTOMER\_IDENTIFICATION | CP\_SYSTEM\_REQUESTS\_CUSTOMER\_IDENTIFICATION - Customer identification to be used equivalent to a card "pre-dip / pre-swipe". This is used to enable loyalty programs at the ECR. Some alternative payment methods support loyalty programs, which are usually linked to using the same provider for alternative payment. | | NOTIF\_TRX\_STARTED | CP\_SYSTEM\_NOTIFIES\_TRANSACTION\_STARTED - Fired by System when exiting the idle screen and ready to initiate a transaction. Exiting idle from a menu like in other services will not fire this event. | | REQUEST\_BASKET\_ADJUSTMENT | CP\_SYSTEM\_REQUESTS\_BASKET\_ADJUSTMENT - The pre-adjusted basket may be responded to by the commerce application by explicit offer format against the basket line details. This would be the case when the commerce application is basket aware and can quickly adjudicate the basket. | | NOTIF\_BASKET\_FINALIZED |CP\_SYSTEM\_NOTIFIES\_BASKET\_FINALIZED - No response is needed to final basket, as attempts to adjudicate the basket are now be closed.
Note: For Payment applications allowing alterations to the basket post tender, it should be noted that a pre-adjusted basket may be received after final to repeat the process if new information is obtained during tendering. For example, basket may be adjusted as a result of trigger CP\_SYSTEM\_REQUESTS\_LOYALTY.
| | REQUEST\_LOYALTY | CP\_SYSTEM\_REQUESTS\_LOYALTY - Loyalty data returned from the launched commerce application. Loyalty response may or may not include offers data. | | REQUEST\_AMOUNT\_ADJUSTMENT |CP\_SYSTEM\_REQUESTS\_AMOUNT\_ADJUSTMENT - Fired by Payment Application when amount is received from POS or entered directly. This amount may have been altered by a discount. Permits the commerce application to adjust the final either by a amount or by an percentage.
Example usage: Pennies application which rounds up the final amount. For example an amount of $8.19 is rounded up to $9.00
| | NOTIF\_AMOUNT\_FINALIZED | CP\_SYSTEM\_NOTIFIES\_AMOUNT\_FINALIZED - 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. | | REQUEST\_ALT\_PAYMENT | CP\_SYSTEM\_REQUESTS\_ALT\_PAYMENT - Fired by Payment Application when one of the alternate payment label has been selected by cardholder. | | REQUEST\_TECH\_ALT\_PAYMENT |CP\_SYSTEM\_REQUESTS\_TECH\_ALT\_PAYMENT - Fired by Payment application when:
An NFC Tag is presented, and is identified as a supported Technology (e.g. MifareClassic, MifareUltralight, FeliCa)
An Iso7816 card has been presented and successfully responds to application selection using a registered AID
| | NOTIF\_CARD\_PRESENTED |CP\_SYSTEM\_NOTIFIES\_CARD\_PRESENTED - Fired by Payment application when:
Magstripe is swiped
Chip card has been inserted and read for PAN
Contacless card/phone has been presented
Access to the card data is on-demand.
| | NOTIF\_CARD\_BIN\_RECEIVED |CP\_SYSTEM\_NOTIFIES\_CARD\_BIN\_RECEIVED - Fired by Payment application when
Magstripe is swiped
Chip card has been inserted and read for PAN
Contacless card/phone has been presented
Access to the card data is on-demand.
This event has card BIN information in the payload
| | REQUEST\_PAYMENT\_AMOUNT\_ADJUSTMENT |CP\_SYSTEM\_REQUESTS\_PAYMENT\_AMOUNT\_ADJUSTMENT - Fired by Payment application with the same conditions as CP\_SYSTEM\_REQUESTS\_AMOUNT\_ADJUSTMENT.
This gives the opportunity for Commerce Applications to adjust the amount only for only certain card types or provide Dynamic Currency Conversion (DCC) capability.
| | NOTIF\_AUTHORIZATION\_COMPLETED | CP\_SYSTEM\_NOTIFIES\_AUTHORIZATION\_COMPLETED - Fired by Payment Application when payment authorization is complete. | | NOTIF\_PAYMENT\_COMPLETED | CP\_SYSTEM\_NOTIFIES\_PAYMENT\_COMPLETED - Fired by Payment Application when payment transaction is completed. This is important because we may be in the payment section for several cycles with split tenders. | | REQUEST\_RECEIPT\_MANAGEMENT | CP\_SYSTEM\_REQUESTS\_RECEIPT\_MANAGEMENT - Fired by Payment Application when a receipt is available to be processed. This allows a CP application to provide electronic receipt management services. This may be triggered multiple times during a transaction, but only once per receipt type. If signature is required for customer verification during a transaction, then this will be triggered by the payment application when verification is required, with signature indicators set. If the request does not contain a signature image, but requires a signature - and the response Provision is NONE or OFFER\_DECLINED then the payment application will have to print the receipt (internal printer or POS printer) to allow verification to be performed as usual. A CP Application may choose to use the CP\_APP\_REQUESTS\_PRINT API call during this trigger to have the payment application produce a physical receipt. | | NOTIF\_TRX\_ENDED | CP\_SYSTEM\_NOTIFIES\_TRANSACTION\_ENDED - Fired by Payment Application when transaction is complete. | ### ErrorCode enum \[ErrorCode]\(#a59e56af19e754a6aa26a612ebf91d05f) Represents possible error codes of invoke call. | | | | -------------------------------------- | --------------------------------------------------------------------- | | Enumerator | | | CP\_INVOKE\_SUCCESS | invoke was successful | | CP\_INVOKE\_FAILED | result of invoke is failed | | CP\_INVOKE\_TIMEOUT | invoke is timed out | | CP\_INVOKE\_MANDATORY\_PARAMS\_MISSING | invoke rejected because mandatory parameters are missing | | CP\_INVOKE\_SERVICE\_SUCCESS | invoke of app type service successful | | CP\_INVOKE\_NATIVE\_SUCCESS | invoke of app type native successful | | CP\_INVOKE\_CANCELED | invoke of app canceled by user | | CP\_INVOKE\_BUSY | trying to invoke a trigger when a previous request is in progress | | CP\_INVOKE\_IDLE | threre is no any trigger invocation in progress when trying to cancel | | CP\_INVOKE\_NOT\_IMPLEMENTED | functionality not implemented | ### HolderAuth enum \[HolderAuth]\(#abc1dfb7e5d03f66392b0b4e8be15af50) Means by which the transaction is authorized. | | | | ------------------------ | -------------------------- | | Enumerator | | | HOLDER\_AUTH\_MIN\_VALUE | min value of enumeration | | HOLDER\_AUTH\_UNDEFINED | holder auth is undefined | | HOLDER\_AUTH\_PIN | holder authorized by pin | | HOLDER\_AUTH\_SIGNATURE | authorized by signature | | HOLDER\_AUTH\_ID | authorized by id | | HOLDER\_AUTH\_OTHER | authorized by other method | | HOLDER\_AUTH\_NONE | holder not authorized | ### OFFER\_TYPE enum \[OFFER\_TYPE]\(#ad7c9d0eab3af08a96ce9fd9ce293de88) Represents the [Offer](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_offer.md) object on CP-Payment communication. | | | | ---------------------------- | ----------------------------------------- | | Enumerator | | | OFFER\_UNDEFINED | offer is undefined | | OFFER\_MERCHANT\_COUPON | offer consists of merchant coupon | | OFFER\_MANUFACTURER\_COUPON | offer consists of manufacturer coupon | | OFFER\_OTHER\_COUPON | offer consists of special coupon | | OFFER\_PRODUCT\_DISCOUNT | offer consists of product discount coupon | | OFFER\_LOYALTY\_CARD | offer consists of loyalty card | | OFFER\_TRANSACTION\_DISCOUNT | offer consists of transaction discount | ### TechnologyType enum \[TechnologyType]\(#a1c203ac3c282fe7696ce695935e2b5dc) | | | | ------------------------------ | ------------------------ | | Enumerator | | | TECH\_TYPE\_MIN\_VALUE | min value of enumeration | | TECH\_TYPE\_UNDEFINED | tech type is undefined | | TECH\_TYPE\_MIFARE\_CLASSIC | | | TECH\_TYPE\_MIFARE\_ULTRALIGHT | | | TECH\_TYPE\_ISO7816 | | ### TransactionOriginator enum \[TransactionOriginator]\(#a6c410aee3c873fc45fe7bccf53c6b8d5) Indicates which entity was responsible for starting the transaction. | | | | -------------------------------- | ------------------------------------------- | | Enumerator | | | ORIGINATOR\_MIN\_VALUE | min value of enumeration | | ORIGINATOR\_UNDEFINED | originator is undefined | | ORIGINATOR\_PAYMENT\_APPLICATION | transaction started by payment application. | | ORIGINATOR\_CP\_APPLICATION | transaction started by cp application | ### TransactionResult enum \[TransactionResult]\(#affde3f05c6a4a5092ccd40ec3e830d43) The result of the transaction | | | | ----------------------- | ------------------------------- | | Enumerator | | | TRX\_RESULT\_MIN\_VALUE | min value of enumeration | | TRX\_RESULT\_UNDEFINED | transaction result is undefined | | TRX\_RESULT\_SUCCESS | transaction result is success | | TRX\_RESULT\_CANCELLED | transaction result is cancelled | ### TransactionType enum \[TransactionType]\(#aa7a2e64697569804f14626bbb2649a58) Type of transaction executed by the Payment Application | | | | ----------------------------------------- | --------------------------------------------------- | | Enumerator | | | TRX\_TYPE\_MIN\_VALUE | min value of enumeration | | TRX\_TYPE\_UNDEFINED | type is undefined | | TRX\_TYPE\_PAYMENT | type of transaction is payment | | TRX\_TYPE\_DEFERRED\_PAYMENT | type of transaction is deferred payment | | TRX\_TYPE\_DEFERRED\_PAYMENT\_COMPLETION | type of transaction is deferred payment completion | | TRX\_TYPE\_REFUND | type of transaction is refund | | TRX\_TYPE\_VOID | type of transaction is void | | TRX\_TYPE\_PRE\_AUTHORISATION | type of transaction is pre authorisation | | TRX\_TYPE\_PRE\_AUTHORISATION\_COMPLETION | type of transaction is pre authorisation completion | | TRX\_TYPE\_CASH\_ADVANCE | type of transaction is cash advance | | TRX\_TYPE\_CASHBACK | type of transaction is cashback | | TRX\_TYPE\_CASH\_PAYMENT | type of transaction is cash payment | | TRX\_TYPE\_REVERSAL | type of transaction is reversal | ### FunctionDocumentation ### deinit() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) void vficpl::deinit deinitialization of Commerce ### getAltPaymentData() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) \[AltPaymentData]\(#structvficpl\_1\_1\_alt\_payment\_data) vficpl::getAltPaymentData Get data returned from CP App while executing CP\_SYSTEM\_REQUESTS\_ALT\_PAYMENT. #### Seealso [AltPaymentData](#structvficpl_1_1_alt_payment_data) ### getApi() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [Api](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_api.md)& vficpl::getApi get API instance #### Returns reference to API object ### getBasket() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::getBasket get basket data used for CP\_SYSTEM\_NOTIFIES\_BASKET\_FINALIZED and CP\_SYSTEM\_REQUESTS\_BASKET\_ADJUSTMENT **Parameters** \[in] **merchandises** - merchandises used by CP App \[in] **offers** - offers used by CP App \[in] **donations** - donations used by CP App #### Returns true if basket is adjusted by CP App ### getCpAppList() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::vector\ vficpl::getCpAppList Get CP application list of given trigger #### Returns vector of strings with application names to the given trigger ### getCpExtraProps() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfiipc_1_1_j_s_object.md) vficpl::getCpExtraProps Get additional configuration entries for given CP application **Parameters** \[in] **appid** - the application id #### Returns js object with extra config or empty object if no such ### getCpPropList() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfiipc_1_1_j_s_object.md) vficpl::getCpPropList Get CP application property js object of given trigger #### Returns js object to the given trigger ### getCustomerIdentification() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) \[CustomerIdentification]\(#structvficpl\_1\_1\_customer\_identification) vficpl::getCustomerIdentification Get data returned from CP App while executing CP\_SYSTEM\_REQUESTS\_CUSTOMER\_IDENTIFICATION. #### Seealso [CustomerIdentification](#structvficpl_1_1_customer_identification) ### getFxAmount() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getFxAmount Get data returned from CP App while executing CP\_SYSTEM\_REQUESTS\_PAYMENT\_AMOUNT\_ADJUSTMENT. ### getFxCurrency() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getFxCurrency Get data returned from Cp App while executing CP\_SYSTEM\_REQUESTS\_PAYMENT\_AMOUNT\_ADJUSTMENT. ### getLoyaltyIdentifiers() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::list\\<[LoyaltyIdentifier](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_loyalty_identifier.md)\\> vficpl::getLoyaltyIdentifiers getLoyaltyIdentifiers returned from CP App while executing CP\_SYSTEM\_REQUESTS\_LOYALTY. #### Returns array of [LoyaltyIdentifier](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_loyalty_identifier.md) objects ### getLoyaltyOffers() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::list\\<[Offer](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvficpl_1_1_offer.md)\\> vficpl::getLoyaltyOffers Get loyalty offers returned from CP App while executing CP\_SYSTEM\_REQUESTS\_LOYALTY. #### Returns array of LoyaltyOffer object ### getPaymentAmountAdjustment() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) \[PaymentAmountAdjustment]\(#structvficpl\_1\_1\_payment\_amount\_adjustment) vficpl::getPaymentAmountAdjustment Get payment amount adjustment Fx fields #### Seealso Paymentamountadjustment ### getProvision() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getProvision get provision - Receipt Management response #### Returns the provision ### getPublisher() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getPublisher get publisher name #### Returns publisher name. Identify which offers or loyalty platform is being leveraged. ### getPublisherId() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getPublisherId get publisher id #### Returns publisher identifier. Provider may elect to pass a numeric identifer for their platform ### getQrCodeString() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) std::string vficpl::getQrCodeString get qr code string #### Returns qr code string (RFU) ### getTechAltPaymentData() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) \[TechAltPaymentData]\(#structvficpl\_1\_1\_tech\_alt\_payment\_data) vficpl::getTechAltPaymentData Get data returned from CP App while executing CP\_SYSTEM\_REQUESTS\_TECH\_ALT\_PAYMENT. #### Seealso [TechAltPaymentData](#structvficpl_1_1_tech_alt_payment_data) ### init()\[1/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init Deprecated initialization of Commerce **Parameters** \[in] **appid** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. #### Returns true on successful initialization ### init()\[2/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init Deprecated initialization of Commerce **Parameters** \[in] **appid** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **api** - api reference to ApiCallbacks implementation. #### Returns true on successful initialization ### init()\[3/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init Deprecated initialization of Commerce **Parameters** \[in] **appid** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **api** - api reference to ApiCallbacks implementation. \[in] **envData** - Environment Data Provider. #### Returns true on successful initialization ### init()\[4/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init Deprecated initialization of Commerce **Parameters** \[in] **appid** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **envData** - Environment Data Provider. #### Returns true on successful initialization ### init()\[5/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init initialization of Commerce **Parameters** \[in] **applicationId** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. #### Returns true on successful initialization ### init()\[6/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init initialization of Commerce **Parameters** \[in] **applicationId** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **api** - api reference to ApiCallbacks implementation. #### Returns true on successful initialization ### init()\[7/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init initialization of Commerce **Parameters** \[in] **applicationId** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **api** - api reference to ApiCallbacks implementation. \[in] **envData** - Environment Data Provider. #### Returns true on successful initialization ### init()\[8/8] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::init initialization of Commerce **Parameters** \[in] **applicationId** - the application id specifies application using commerce \[in] **trxData** - Transaction Data Provider taken from current transaction. \[in] **envData** - Environment Data Provider. #### Returns true on successful initialization ### invoke()\[1/3] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invoke sends the notification to CP. The call will be blocking the thread until CP app is closed. decision for request/response or request only is done internally depending on trigger. **Parameters** \[in] **trigger** - the trigger message that will be sent to CPR #### Returns returns whether the notification was delivered ### invoke()\[2/3] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invoke sends the notification to CP. The call will be blocking the thread until CP app is closed. decision for request/response or request only is done internally depending on trigger. **Parameters** \[in] **trigger** - the trigger message that will be sent to CPR \[in] **sysToForground** - default parameter executing sysToForground at end of invoke #### Returns returns whether the notification was delivered ### invoke()\[3/3] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) \[ErrorCode]\(#a59e56af19e754a6aa26a612ebf91d05f) vficpl::invoke ### invokeByName()\[1/2] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invokeByName sends the notification to CP. The call will be blocking the thread until CP app is closed. decision for request/response or request only is done internally depending on trigger. **Parameters** \[in] **trigger** - the trigger message that will be sent to CPR **programName** - name of the program that will be started in mac #### Returns returns whether the notification was delivered ### invokeByName()\[2/2] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invokeByName sends the notification to CP. The call will be blocking the thread until CP app is closed. decision for request/response or request only is done internally depending on trigger. **Parameters** \[in] **trigger** - the trigger message that will be sent to CPR **programName** - name of the program that will be started in mac \[in] **sysToForground** - default parameter executing sysToForground at end of invoke #### Returns returns whether the notification was delivered ### invokeFromDesktop()\[1/2] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invokeFromDesktop invoke from desktop shows application selection desktop with all apps from a given trigger. After selection the program is directly invoked in mac. This method waits until the application ends. **Parameters** **trigger** which is used for application selection #### Returns returns whether the application has been executed ### invokeFromDesktop()\[2/2] [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) [InvokeResult](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvficpl_1_1_invoke_result.md) vficpl::invokeFromDesktop invoke from desktop shows application selection desktop with all apps from a given trigger. After selection the program is directly invoked in mac. This method waits until the application ends. **Parameters** **trigger** which is used for application selection \[in] **sysToForground** - default parameter executing sysToForground at end of invoke #### Returns returns whether the application has been executed ### setApi() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::setApi set instance of API object **Parameters** \[in] **api** - the api reference to ApiCallbacks implementation #### Returns true on success ### setBasket() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) void vficpl::setBasket set basket data used for CP\_SYSTEM\_NOTIFIES\_BASKET\_FINALIZED and CP\_SYSTEM\_REQUESTS\_BASKET\_ADJUSTMENT **Parameters** \[in] **merchandises** - merchandises send to CP App \[in] **offers** - offers send to CP App \[in] **donations** - donations send to CP App ### setEnvironmentDataProvider() [CPDllSpec](/adk-5.0-programmers-guide/readme/files/dir_2002fcb36e937be08e088f9ab4e81de8/dir_fad52422ca9a0153aca9cfe879bff259/dir_613e11e510006a27889deef70cf7d9b4/cpdllspec_8h.md#a405283673573049b0d38f77c79ee0e06) bool vficpl::setEnvironmentDataProvider Sets new Environment Data Provider **Parameters** \[in] **envData** - reference to EnvironmentDataProvider #### Returns true on success --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/namespaces/namespacevficpl.md?ask=