SDK overview

The Alipay+ NFC SDK provides APIs for implementing Alipay+ NFC payment functionality in your applications. The following table lists the available functions.

Category	Function	Use
Initialization	ACTapManager.init(config)	Initialize the client SDK.
	ACTapManager.connect(String id)	Connect to the SDK secure wallet.
	ACTapManager.disconnect()	Disconnect from the SDK secure wallet.
	ACTapManager.destroy()	Deinitialize the Alipay+ NFC SDK.
Card activation	ACTapManager.activatePayment()	Activate the card.
	ACTapManager.activatePaymentInSlientMode()	Activate the Host Card Emulation (HCE) payment function in silent mode.
	ACTapManager.cancelActivateProcess()	Cancel the card activation process.
	ACTapManager.isPaymentAvailable()	Determine if the payment function is available.
	ACTapManager.onNotificationDataReceived(String notificationData)	Receive notifications related to card token activation.
	ACTapManager.replenish()	Replenish transaction Credentials.
	ACTapManager.getAvailableCredentialsCounts()	Obtain the number of available credentials.
	ApplyCardActivity.apply(activity: Activity, requestCode: Int, apduServiceName: String)	Activate the card application activity.
Card management	ACTapManager.lock()	Lock the card through the MPP app.
	ACTapManager.unlock()	Unlock the card through the MPP app.
	ACTapManager.deleteToken()	Delete the NFC card activation token.
Transaction	ACTapManager.auth(AuthMethod)	Authentication.
	ACTapManager.setPassFreeLimitAmount(amountLevelKey)	Set the pass free limit amount.
	ACTapManager.setCustomData(bye[] data)	Set custom data that is to be passed through to the card issuer.
SPI	NFCRequestProxy	Proxy network requests via App.
	TransactionPermit	Authentication in transaction.
	ConfigProxy	Remote configuration delivery.
	LoggerProxy	Print out logs.
	DeviceFingerPrintService	Obtain fingerprint from wallet device.
	NFCMonitor	Detect the SDK's execution status.
	ThreadPoolService	Implement and manage your own thread pool.
	EncryptionProxy	Encrypt or decrypt sensitive data.
	StorageService	Store and manage key-value pairs.
Listener	ACTapManager.setTransactionListener(TransactionListener)	Monitor transaction process and provide callback.
	ACTapManager.setTokenStatusListener(TokenStatusListener)	Monitor wallet status change and provide callback.
	ACTapManager.setActivateStatusListener(ActivateStatusListener)	Monitor the status of the activatePayment API and provide callback.
	ACTapManager.getInstance(application).removeActivateStatusListener(ActivateStatusListener)	Remove the activation status listener when the activity gets destroyed.
	ACTapManager.getInstance(application).removeTokenStatusListener(TokenStatusListener)	Remove the token status listener when the activity gets destroyed.
	ACTapManager.registerPlugin()	Register extension function.
NFC settings	ApplyCardActivity.setting(activity: Activity, apduServiceName: String)	Enable the NFC payment function.
NFC settings	NFCUtils.isNfcPaySettingsCompleted(activity: Activity, apduServiceName: String)	Check if NFC payment is enabled.
Callback	ACResultCallback	The general callback API.