Table of Contents
Overview
Customer-Present Cloud offers a versatile solution by allowing additional parameters to be passed within payment requests. One such feature is PAN Keyed Entry, enabling manual input of a customer's credit card information via the payment device. However, it's important to note that this method should only be used with supported MOTO processors and payment devices, as it constitutes a Card Not Present transaction due to manual keying.
This article provides a comprehensive guide on leveraging Customer-Present Cloud's POI Device Prompts to enable both optional and required Keyed Entry during transactions.
Prompt Device for Keyed Entry
Optional Keyed Entry
The first method of keyed entry available via Customer-Present Cloud is optional keyed entry. This method will have the payment device provide an option to key-in the customer's payment information, allowing the choice to use keyed entry if needed. For example, if a customer’s card isn’t being read properly though a chip, swipe, or tap method, you can still process credit card transactions by manually entering the card details through the payment device.
In order to perform this method of keyed entry with Customer-Present Cloud, integrations will need to provide an additional parameter to the API request known as poi_enable_keyed
.
Variable Name | Description |
---|---|
poi_enable_keyed | When set to 'true', provides the option to key-in the card details via the POI Device. Format: boolean (true/false) Default: false |
Additional note: This POI Device Prompt is not supported by Miura devices. Should this be attempted with a Miura device no option for Keyed Entry will appear.
Here is an example of a Customer-Present Cloud API request, where the integration will pass poi_enable_keyed
to allow users to manually enter the customer's payment details:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
poi_enable_keyed : true
]
The above example will submit an API request and begin the payment device interaction. Within the payment device an option to "Enter Card" will appear (on supporting devices). If selected for keyed entry the payment device will request the customer's card number, expiry date and card security code to be entered manually.
Required Keyed Entry
With Customer-Present Cloud, integrations may also enable required keyed entry. Required keyed entry will prompt for the manual input of customer's payment details for every transaction. When utilizing the required keyed entry or poi_require_keyed
it will void any additional entry methods passed within the Customer-Present Cloud request.
In order to perform this method of keyed entry with Customer-Present Cloud, integrations will need to provide an additional parameter to the API request known as poi_require_keyed
.
Variable Name | Description |
---|---|
poi_require_keyed |
When set to 'true', forces the cardholder to key-in the card details via the POI Device. Format: boolean (true/false) Default: false |
Additional note: This POI Device Prompt is not supported by Miura devices. Should this be attempted with a Miura device no option for Keyed Entry will appear.
Here is an example of a Customer-Present Cloud API request, where the integration will pass poi_require_keyed
to allow users to manually enter the customer's payment details:
POST: /api/transact.php
PARAMS:
[
security_key : your_security_key
poi_device_id : "POI Device ID Here"
type : sale
amount : 10.00
response_method : asynchronous
poi_require_keyed : true
]
The above example will submit an API request and begin the payment device interaction. Within the payment device a "Enter Card" prompt will appear (on supporting devices) requesting for the customer's card number, expiry date and card security code to be manually input onto the payment device.