Best way to integrate apple wallet into your mobile app. Cordova Apple Wallet let you add your credit/debit cards to Apple Wallet through your mobile app. It also can check if the credit/debit card exists in Wallet or any paired device e.g. Apple Watch β
- Getting Started
- Supporting
- Installation instructions
- How to use
- API
- Demo
- Contributing
- License
- Credits
Attention Adding payment passes requires a special entitlement issued by Apple. Your app must include this entitlement before you can use this class. For more information on requesting this entitlement, see the Card Issuers section at here.
For more technical information, please check Apple Developer documentation from here and Here,
cordova-apple-wallet is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible thanks to the support of our awesome collaborators.
If you think that any information you obtained here is worth of some money and are willing to pay for it, you can give me a cup of coffee β π
In order to use it with Ionic 3, please follow this instructions
cordova plugin add cordova-apple-wallet --saveOr the latest version:
cordova plugin add --save https://github.com/tomavic/cordova-apple-walletπ NOTE: In order to use it with normal cordova based project, please define a global variable, so that you can use it without lint errors var AppleWallet = AppleWallet || {};
- Availability
- Eligibility
- Card Addition
- Paired Devices (π NEW)
Simple call to determine if the current device supports Apple Pay and has a supported card installed.
AppleWallet.isAvailable()
.then((res) => {
/**
* Expect res to be boolean
*/
})
.catch((err) => {
// Catch {{err}} here
});Simple call to check Card Eligibility
primaryAccountIdentifier (String) Your card unique identifier that used in card in-app provisioning
AppleWallet.checkCardEligibility(primaryAccountIdentifier)
.then((res) => {
/**
* Expect res to be boolean
*/
})
.catch((err) => {
// Catch {{err}} here
});Simple call to checkCardEligibilityBySuffix
cardSuffix (String) The card number suffix ex: last 4 or 6 digits
AppleWallet.checkCardEligibilityBySuffix(cardSuffix)
.then((res) => {
/**
* Expect res to be boolean
*/
})
.catch((err) => {
// Catch {{err}} here
});Simple call with the configuration data needed to instantiate a new PKAddPaymentPassViewController object.
This method provides the data needed to create a request to add your payment pass (credit/debit card). After a successful callback, pass the certificate chain to your issuer server-side using our callback delegate method AppleWallet.completeAddPaymentPass. The issuer server-side should returns an encrypted JSON payload containing the encrypted card data, which is required to be get the final response
let data = {
cardholderName: 'Test User',
primaryAccountSuffix: '1234',
localizedDescription: 'Description of payment card',
paymentNetwork: 'VISA',
encryptionScheme: 'RSA_V2' // This could be ECC_V2 or RSA_V2 - Default is RSA_V2
}
AppleWallet.startAddPaymentPass(data)
.then((res) => {
/**
* User proceed and successfully asked to add card to his wallet
* Use the callback response JSON payload to complete addition process
* Expect
* res = {
* "data": {
* "certificateSubCA":"Base64 string represents certificateSubCA",
* "certificateLeaf":"Base64 string represents certificateLeaf"
* "nonce":"Base64 string represents nonce",
* "nonceSignature":"Base64 string represents nonceSignature",
* }
* }
*/
})
.catch((err) => {
// Error or user cancelled.
});π NOTE: The encryption scheme, cardholder name, and primary account suffix are required for configuration. The configuration information is used for setup and display only. It should not contain any sensitive information.
In order to get testing data check this Apple Sandbox
Simple completion handler that takes encrypted card data returned from your server side, in order to get the final response from Apple to know if the card is added succesfully or not.
activationData: The requestβs activation data.encryptedPassData: An encrypted JSON file containing the sensitive information needed to add a card to Apple Pay.ephemeralPublicKeyThe ephemeral public key used by elliptic curve cryptography (ECC). orwrappedKeyif you are using RSA
let encryptedData = {
activationData: "encoded Base64 activationData from your server",
encryptedPassData: "encoded Base64 encryptedPassData from your server",
wrappedKey: "encoded Base64 wrappedKey from your server"
}
AppleWallet.completeAddPaymentPass(encryptedData)
.then((res) => {
/**
* A success callback response means card has been added successfully,
* PKAddPaymentPassViewController will be dismissed
* Expect
* res to be String value 'success' or 'error'
*/
})
.catch((err) => {
// Error and can not add the card, or something wrong happend
// PKAddPaymentPassViewController will be dismissed
});Simple call to check out if there is any paired Watches so that you can toggle visibility of 'Add to Watch' button
AppleWallet.checkPairedDevices()
.then((res) => {
/**
* Expect
* res = {
* isWatchPaired: boolean
* }
*/
})
.catch((err) => {
// Catch {{err}} here
});Simple call to check paired devices with a card by its suffix
cardSuffix (String) The card number suffix ex: last 4 or 6 digits
AppleWallet.checkPairedDevicesBySuffix(cardSuffix)
.then((res) => {
/**
* object contains boolean values that ensure that card is already exists in wallet or paired-watch
* Expect
* res = {
* isInWallet: boolean
* isInWatch: boolean
* FPANID: string
* }
* */
})
.catch((err) => {
// Catch {{err}} here
});Soon..
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
MIT
Made with β€οΈβ€οΈ .
I am always happy to hear your feedback @Twitter
Enjoy!
βββββββββββββββββββββββββββββββββββββββββββββ
ββββββββββββββββββββββββββββββββββββββββββββ
ββββββββ βββββββββββββββββββββββββββββββββββ
All copyrights reserved | 2018-2020
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent