https://github.com/devnied/emv-nfc-paycard-enrollment

A Java library used to read and extract data from NFC EMV credit cards (Android/PCSC).
https://github.com/devnied/emv-nfc-paycard-enrollment

android credit-card emv java java-library nfc tlv track2

Last synced: 29 days ago
JSON representation

A Java library used to read and extract data from NFC EMV credit cards (Android/PCSC).

• Host: GitHub
• URL: https://github.com/devnied/emv-nfc-paycard-enrollment
• Owner: devnied
• License: apache-2.0
• Created: 2014-04-05T13:47:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-03T18:18:52.000Z (about 1 month ago)
• Last Synced: 2024-10-15T04:02:51.578Z (29 days ago)
• Topics: android, credit-card, emv, java, java-library, nfc, tlv, track2
• Language: Java
• Homepage:
• Size: 4.05 MB
• Stars: 1,480
• Watchers: 124
• Forks: 596
• Open Issues: 24
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## EMV NFC Paycard Enrollment ![CI](https://github.com/devnied/EMV-NFC-Paycard-Enrollment/workflows/CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/devnied/EMV-NFC-Paycard-Enrollment/badge.svg?branch=master)](https://coveralls.io/github/devnied/EMV-NFC-Paycard-Enrollment?branch=master) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.devnied.emvnfccard/library/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.github.devnied.emvnfccard/library) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

### Description

Java library used to read and extract public data from NFC EMV credit cards.





Android sample app available on Play store.



### Getting started

First you need to create a custom Provider to exchange APDU with an NFC EMV credit card ([sample here](https://github.com/devnied/EMV-NFC-Paycard-Enrollment/blob/master/sample-pcsc/src/main/java/com/github/devnied/emvpcsccard/PcscProvider.java)).

```java

public class YourProvider implements IProvider {

  @Override

  public byte[] transceive(final byte[] pCommand) {

	 // implement this

  }

  @Override

  public byte[] getAt() {

     // implement this to get card ATR (Answer To Reset) or ATS (Answer To Select)

  }

}

```

After that, create an instance of a parser and read the card.

```java

// Create provider

IProvider provider = new YourProvider();

// Define config

Config config = EmvTemplate.Config()

		.setContactLess(true) // Enable contact less reading (default: true)

		.setReadAllAids(true) // Read all aids in card (default: true)

		.setReadTransactions(true) // Read all transactions (default: true)

		.setReadCplc(false) // Read and extract CPCLC data (default: false)

		.setRemoveDefaultParsers(false) // Remove default parsers for GeldKarte and EmvCard (default: false)

		.setReadAt(true) // Read and extract ATR/ATS and description

		; 

// Create Parser

EmvTemplate parser = EmvTemplate.Builder() //

		.setProvider(provider) // Define provider

		.setConfig(config) // Define config

		//.setTerminal(terminal) (optional) you can define a custom terminal implementation to create APDU

		.build();

		

// Read card

EMVCard card = parser.readEmvCard();

```

card object contains all data read (Aid, card number, expiration date, card type, transactions history)

#### Android usage

For android, you can create a provider with [IsoDep](https://developer.android.com/reference/android/nfc/tech/IsoDep) class:

```java

public class Provider implements IProvider {

	private IsoDep mTagCom;

	@Override

	public byte[] transceive(final byte[] pCommand) throws CommunicationException {

		

		byte[] response;

		try {

			// send command to emv card

			response = mTagCom.transceive(pCommand);

		} catch (IOException e) {

			throw new CommunicationException(e.getMessage());

		}

		return response;

	}

	@Override

	public byte[] getAt() {

        // For NFC-A

		return mTagCom.getHistoricalBytes();

		// For NFC-B

        // return mTagCom.getHiLayerResponse();

	}

	public void setmTagCom(final IsoDep mTagCom) {

		this.mTagCom = mTagCom;

	}

}

```

### Screens

[![Sample demo](https://raw.githubusercontent.com/devnied/EMV-NFC-Paycard-Enrollment/master/images/demo.gif)](https://raw.githubusercontent.com/devnied/EMV-NFC-Paycard-Enrollment/master/images/demo.gif)

## Download

### Maven

```xml

  com.github.devnied.emvnfccard

  library

  3.0.1

```

### Gradle

```groovy

dependencies {

	compile 'com.github.devnied.emvnfccard:library:3.0.1'

}

```

### JAR

You can download this library on [Maven central](http://search.maven.org/#search%7Cga%7C1%7Cemvnfccard) or in Github [release tab](https://github.com/devnied/EMV-NFC-Paycard-Enrollment/releases)

## Dependencies

If you are not using Maven or some other dependency management tool that can understand Maven repositories, the list below is what you need to run EMV-NFC-Paycard-Enrollment.

## Build

**To build the project launch:**

```xml

mvn clean install

```

## Bugs

Please report bugs and feature requests to the GitHub issue tracker.


Forks and Pull Requests are also welcome.

## Author

**Millau Julien**

+ [http://twitter.com/devnied](http://twitter.com/devnied)

+ [http://github.com/devnied](http://github.com/devnied)

## Copyright and license

Copyright 2020 Millau Julien.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this work except in compliance with the License.

You may obtain a copy of the License in the LICENSE file, or at:

  [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.