nfc-card-reader

An Android Library to read info from NFC enabled cards

Note - This library does not log or send any of the sensitive card information. All processing is done on the device

Inspired from EMV-NFC-Paycard-Enrollment and Credit-Card-NFC-Reader

Getting started

Add this to your project's build.gradle

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

And include the dependency in your module's build.gradle

dependencies {
  implementation 'com.github.vickyramachandra:nfc-card-reader:1.4.0'
}

Usage

Make sure to handle if the device has NFC capabilities and it is enabled. In the Activity

public class MainActivity extends AppCompatActivity {

  private NfcCardManager nfcCardManager;
  private NfcCardReader nfcCardReader;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    nfcCardManager = new NfcCardManager(this);
    nfcCardReader = new NfcCardReader();
  }
  
  @Override
  protected void onResume() {
    super.onResume();
    nfcCardManager.enableDispatch();
  }

  @Override
  protected void onPause() {
    super.onPause();
    nfcCardManager.disableDispatch();
  }

  @Override
  protected void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    // When the card is brought closer to the device, a new intent with TAG info is dispatched
    Tag tag = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
    if (tag != null) {
      NfcCardResponse cardResponse = nfcCardReader.readCard(tag); // read the card data with tag
      if (cardResponse != null && cardResponse.getEmvCard() != null) {
        // use card data such as card number, expiry date etc
      }
    }
  }
}  

License

MIT License

Copyright (c) 2020 Vignesh Ramachandra

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.