Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise.
They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are.
Without these cookies, online advertisements you encounter will be less relevant to you and your interests.


Cookie Settings

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

This method directs the card reader to request a PIN from the cardholder.

:::::notice{note}

 This method requires a valid connected card reader.

 ROAM readers do not support manual entry for on-demand card read due to lack of a pinpad.
:::::

## Code Samples

### CWS 

#### Request

| Property | Description |
| --- | --- |
| method string required | `startPinEntryOnCardReader` |
| requestId string required | Transaction Request ID |
| targetType string required | `cardReader` |
| parameters JSONObject required | All relevant parameters to initiate a PIN entry prompt. |
| maskedPan string required | Masked Card Number |

#### Response

| Property | Description |
| --- | --- |
| requestId string | Transaction Request ID As specified in the request. |
| statusDetails string | Request Status |
| data JSONObject | Object holding various responses. |
| pinData JSONObject | PIN Data Object containing KSN, PIN and encryption method. |
| ksn string | Key Serial Number |
| pin string | Masked Card Number |
| encryptionMethod string | Encryption Method |

#### Example

##### Request

```json
{
 "method" : "startPinEntryOnCardReader",
 "requestId" : "1669463288",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "maskedPan" : "******"
 }
}
```

Later...

```json
{
 "method" : "getCommandStatusOnCardReader",
 "requestId" : "1669463292",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "id" : "1669463288"
 }
}
```

##### Response

```json
{
 "requestId" : "1669463288",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "cardReaderCommand" : {
 "eventQueue" : [ ],
 "id" : "1669463288",
 "completed" : false
 }
 }
}
```

Later...

```json
{
 "requestId" : "1669463292",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "cardReaderCommand" : {
 "eventQueue" : [ {
 "timeStamp" : "1477519715293",
 "statusDetails" : "PIN_ENTRY_COMPLETED"
 } ],
 "id" : "1669463288",
 "pinData" : {
 "ksn" : "******",
 "pin" : "******",
 "encryptionMethod" : "DUKPT"
 },
 "completed" : true
 }
 }
}
```

### Java 

```java
ECLMagStripeCardData cardData = new ECLMagStripeCardData(ECLCardEntryType.UNKNOWN, null, null, ECLTriState.UNKNOWN);

String maskedPan = commerceAccount.getCardReader().getLastProvidedSwipedData().getMaskedPan();
cardData.setMaskedPan(maskedPan);

cardReaderInterface.retrievePin(new ECLCardReaderRetrievePinListener()
{
 @Override
 public void cardReaderProvidedPin(ECLCardReaderInterface cardReader, ECLCardReaderPin pinResult)
 {
 /* Use pinResult */
 }

 @Override
 public void cardReaderRetrievePinError(ECLCardReaderInterface cardReader, ECCError error)
 {
 /* Handle error */
 }

 @Override
 public void cardReaderProgress(ECLCardReaderInterface cardReader, ECLTransactionProgress progress)
 {
 logger.info("cardReaderProgress " + progress.toString());
 }
}, cardData);

/* ECLCardReaderPin has the following public methods */
public class ECLCardReaderPin
{
 public ECLEncryptionMethod getEncryptionMethod();
 public String getKsn();
 public String getPin();
}
```

### Objective-C 

```objc
// Card data from last on-demand card read
ECLMagStripeCardData *prevCardData;

// Card reader instance
id<ECLCardReaderProtocol> cardReader;

[cardReader retrievePin:self forCardData:prevCardData];

// Implement ECLCardReaderRetrievePinDelegate callback methods
+ (void)cardReaderRetrievePin:(id<ECLCardReaderProtocol>)cardReader providedPin:(ECLCardReaderPin *)pinResult 
{
 /* Use pinResult */
}
 
+ (void)cardReaderRetrievePin:(id<ECLCardReaderProtocol>)cardReader error:(NSError *)error 
{
 /* Handle error */
}

+ (void)cardReaderRetrievePin:(id<ECLCardReaderProtocol>)cardReader progress:(ECLTransactionProgress)progress 
{
 [self addStatusString:[NSString stringWithFormat:@"%@\n",[ECLDebugDescriptions descriptionOfTransactionProgress:progress]]];
}


// ECLCardReaderPin has the following properties
@interface ECLCardReaderPin : NSObject

@property (readonly)ECLCardReaderPinEncryptionMethod encryptionMethod;
@property (readonly)NSString *ksn;
@property (readonly)NSString *pin;
```

### C\# 

```c#
/* Asynchronous */
 m_CWS.StartPinEntry(myMaskedPan, MyNotifyCWSEvent, MyPinEntryComplete);

/* Synchronous */
 PinEntryResults per = m_CWS.PinEntry(myMaskedPan, null);
 MyPinEntryComplete(per);

/* Do something with the pin data */

 public void MyPinEntryComplete(PinEntryResults per)
 {
 Log("----------- PinEntry Complete ------------");
 PinData pd = per.PinData;
 if (null != pd)
 {
 Log(String.Format("KSN {0}", pd.ksn));
 Log(String.Format("Pin {0}", pd.pin));
 Log(String.Format("EncryptionMethod {0}", pd.encryptionMethod));
```

Prompt PIN Entry

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Bank Holidays

Card Activation

Card Controls

Commercial Credit Cards

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards Balance Summary

Rewards Redemption Coming Soon

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

Avvance

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Card as a Service API

Check Payables

Core Banking API

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

Money Movement API

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

Reference API

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Elavon Commerce SDK Overview

Getting Started

Integration Methods

Commerce Web Services

Java (Windows)

Java (Android)

Objective-C (iOS)

System

Get Environment Information

Get Converge Account Information

Validate BMS Credentials

Payment Terminals

Payment Terminals Overview

Ingenico

iCMP

iPP320

iSC250

Lane 3000

Lane 5000

Link 2500

Moby 5500

RP457c

Self 4000

Card Reader Connection

Device Connection Criteria

Card Reader Configuration

Get Card Reader Information

24-Hour Reboot

On-Demand

Get Device Status

Reset Card Reader

Reboot Card Reader

Encrypted Card Read

Cancel Card Read

Capture Card Data

Get Customer Input

Phone Number

Volume Control

Set Shutdown Timeout

Signature Capture

Set Time Zone on Card Reader

TMS Update Check Time Window

SSL Certificate Update Process for Card Reader

Printers

Printers Overview

Get Printer Information

Print Receipts

On Demand Print Receipt

Transaction Types

Transactions Overview

Sale

Auth Only

Auth Only Increment

Convert Auth Only to Sale

Auth Only Reversal

Void

Linked Refund

Stand Alone Refund

Debit Balance Inquiry

Post Auth Tip Adjust

Continue Transaction

Cancel Transaction

Transaction Lookup

Processing Options

Processing Options Overview

Address Verification Service

Force Sale

Gratuity

Manual Card Data Entry

Merchant Transaction Reference

Partial Approval

Token Request

Pay with Token

Retrieve CVM Signature

Invoice Number

Lane Number

OAR-PS2000 Data

Healthcare

Dynamic currency conversion

Credit Surcharge

Credit Surcharge Overview

Surcharge Property Retrieval

Token Transaction for Surcharge

Transaction Outcome Field for Surcharge

Transaction Search Result for Surcharge

Surcharge In-App

Service Fee

Service Fee Overview

Service Fee Property Retrieval

Token Transaction for Service Fee

Transaction Outcome Field for Service Fee

Transaction Search Result for Service Fee

Service Fee In-App