Capacitor plugin for Apple Pay payments
This Apple Pay plugin provides interfaces that allow you to initiate an Apple Pay payment sheet based on provided PaymentRequest.
When transaction is authorized, Payment response is returned along with payment details and more importantly- a payment token that you should pass to your backend.
For Capacitor 4 please use version 4.0.0+
For Capacitor 3 please use lower versions.
npm install @fresha/capacitor-plugin-applepay
npx cap sync
Before using this plugin, make sure that your project is correctly configured. Usually your Payment Services Processor will provide detailed instructions, so please read their docs first.
Apple Pay Payment Processing Certificate
canMakePayments() => Promise<CanMakePaymentsResponse>
Indicates whether the device supports Apple Pay.
Returns: Promise<CanMakePaymentsResponse>
canMakePayments(options: CanMakePaymentsRequest) => Promise<CanMakePaymentsResponse>
Indicates whether the device supports Apple Pay and whether the user has an active card.
This allows more granular control than regular canMakePayments()
Param | Type | Description |
---|---|---|
options |
CanMakePaymentsRequest |
- Supported networks and capabilities |
Returns: Promise<CanMakePaymentsResponse>
initiatePayment(request: InitiatePaymentRequest) => Promise<InitiatePaymentResponse>
Initiates a payment base on PaymentRequest object.
Param | Type | Description |
---|---|---|
request |
InitiatePaymentRequest |
- PaymentRequest object that will be used for the payment. |
Returns: Promise<InitiatePaymentResponse>
completeLastPayment(request: CompletePaymentRequest) => Promise<void>
Completes current payment
Param | Type | Description |
---|---|---|
request |
CompletePaymentRequest |
- CompletePaymentRequest object containing status |
Prop | Type |
---|---|
canMakePayments |
boolean |
Prop | Type |
---|---|
networks |
PaymentNetwork[] |
capabilities |
MerchantCapability[] |
Prop | Type |
---|---|
token |
{ paymentData?: string; transactionIdentifier: string; paymentMethod: { displayName?: string; secureElementPass?: { deviceAccountNumberSuffix: string; deviceAccountIdentifier: string; primaryAccountIdentifier: string; primaryAccountNumberSuffix: string; devicePassIdentifier?: string; pairedTerminalIdentifier?: string; }; }; } |
billingContact |
PaymentContact |
shippingContact |
PaymentContact |
Prop | Type |
---|---|
emailAddress |
string |
phoneNumber |
string |
name |
PersonNameComponents |
postalAddress |
{ street?: string; city?: string; postalCode?: string; country?: string; isoCountryCode?: string; subAdministrativeArea?: string; subLocality?: string; } |
Prop | Type |
---|---|
familyName |
string |
givenName |
string |
namePrefix |
string |
middleName |
string |
nameSuffix |
string |
nickname |
string |
Prop | Type |
---|---|
merchantIdentifier |
string |
countryCode |
string |
currencyCode |
string |
supportedCountries |
string[] |
supportedNetworks |
PaymentNetwork[] |
summaryItems |
PaymentSummaryItem[] |
requiredShippingContactFields |
ContactField[] |
requiredBillingContactFields |
ContactField[] |
merchantCapabilities |
MerchantCapability[] |
billingContact |
PaymentContact |
shippingContact |
PaymentContact |
Prop | Type |
---|---|
label |
string |
amount |
string |
type |
PaymentSummaryItemType |
Prop | Type |
---|---|
status |
PaymentCompletionStatus |
‘amex’ | ‘chinaUnionPay’ | ‘cartesBancaires’ | ‘discover’ | ‘eftpos’ | ‘electron’ | ‘idCredit’ | ‘interac’ | ‘JCB’ | ‘maestro’ | ‘masterCard’ | ‘privateLabel’ | ‘quicPay’ | ‘suica’ | ‘visa’ | ‘vPay’
‘capability3DS’ | ‘capabilityCredit’ | ‘capabilityDebit’ | ‘capabilityEMV’
‘pending’ | ‘final’
‘emailAddress’ | ‘name’ | ‘phoneNumber’ | ‘phoneticName’ | ‘postalAddress’
‘success’ | ‘failure’