API
Aus den öffentlichen API-Metadaten von @capacitor-community/stripe v8.2.1 erzeugte Referenz. Plattformgrenzen, geerbte Optionsfelder, Lebenszyklus der Ergebnis-Listener und Serverzuständigkeiten sind auf den Methodenseiten dokumentiert.
Methoden
method initialize(...)
Konfiguriert das Stripe SDK. Vor der Verwendung einer Zahlungsmethode einmal aufrufen.
initialize(opts: StripeInitializationOptions) => Promise<void>
method handleURLCallback(...)
Übergibt eine eingehende Rückkehr-URL nach einer Authentifizierung mit Weiterleitung
an das Stripe SDK.
Nur iOS. Aus dem URL-Handler der App aufrufen, wenn Stripe zurück
zur Anwendung weiterleitet.
handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>
method isApplePayAvailable()
Wird aufgelöst, wenn Apple Pay verfügbar ist, und andernfalls abgelehnt.
Apple Pay wird auf iOS und in kompatiblen Webbrowsern unterstützt, nicht auf Android.
isApplePayAvailable() => Promise<void>
method createApplePay(...)
Erstellt eine Apple-Pay-Anfrage. Vor presentApplePay() aufrufen.
createApplePay(options: CreateApplePayOption) => Promise<void>
method presentApplePay()
Zeigt die mit createApplePay() erstellte Apple-Pay-Anfrage an.
presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>
method updateApplePaySheet(...)
Aktualisiert nach einem Versandkontakt-Callback den nativen Apple-Pay-Dialog.
Nur iOS; im Web wird diese Methode nicht unterstützt.
updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>
method isGooglePayAvailable()
Wird aufgelöst, wenn Google Pay verfügbar ist, und andernfalls abgelehnt.
Google Pay wird auf Android und in kompatiblen Webbrowsern unterstützt, nicht auf iOS.
isGooglePayAvailable() => Promise<void>
method createGooglePay(...)
Erstellt eine Google-Pay-Anfrage. Vor presentGooglePay() aufrufen.
createGooglePay(options: CreateGooglePayOption) => Promise<void>
method presentGooglePay()
Zeigt die mit createGooglePay() erstellte Google-Pay-Anfrage an.
presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>
method createPaymentFlow(...)
Erstellt eine PaymentFlow-Instanz. PaymentFlow verwenden, wenn die App
zunächst Zahlungsdaten erfassen und sie in einem späteren Schritt bestätigen muss.
createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>
method presentPaymentFlow()
Zeigt den mit createPaymentFlow() erstellten PaymentFlow an und wird
mit den letzten vier Ziffern der ausgewählten Karte aufgelöst.
presentPaymentFlow() => Promise<{ cardNumber: string; }>
method confirmPaymentFlow()
Bestätigt die von presentPaymentFlow() erfassten Zahlungsdaten.
confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>
method createPaymentSheet(...)
Erstellt und konfiguriert eine PaymentSheet-Instanz. Vor
presentPaymentSheet() dieses Promise oder das Ereignis Loaded abwarten.
createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>
method presentPaymentSheet()
Zeigt das mit createPaymentSheet() erstellte PaymentSheet an und wird
mit dem Ergebnis für Abschluss, Abbruch oder Fehlschlag aufgelöst.
presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>
method addListener(ApplePayEventsEnum.Loaded, ...)
Wird ausgelöst, wenn die Apple-Pay-Anfrage zur Anzeige bereit ist.
addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.FailedToLoad, ...)
Wird ausgelöst, wenn die Apple-Pay-Anfrage nicht erstellt werden konnte.
addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.Completed, ...)
Wird nach dem erfolgreichen Abschluss von Apple Pay ausgelöst.
addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.Canceled, ...)
Wird ausgelöst, wenn der Kunde Apple Pay abbricht.
addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.Failed, ...)
Wird ausgelöst, wenn Apple Pay fehlschlägt.
addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)
Nur iOS. Wird ausgelöst, wenn der Kunde einen Versandkontakt auswählt. Die
übergebene updateId mit updateApplePaySheet() verwenden.
addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>
method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)
Nur iOS. Wird ausgelöst, nachdem Apple Pay seine Stripe PaymentMethod erstellt hat.
addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>
method addListener(GooglePayEventsEnum.Loaded, ...)
Wird ausgelöst, wenn die Google-Pay-Anfrage zur Anzeige bereit ist.
addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(GooglePayEventsEnum.FailedToLoad, ...)
Wird ausgelöst, wenn die Google-Pay-Anfrage nicht erstellt werden konnte.
addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(GooglePayEventsEnum.Completed, ...)
Wird nach dem erfolgreichen Abschluss von Google Pay ausgelöst.
addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(GooglePayEventsEnum.Canceled, ...)
Wird ausgelöst, wenn der Kunde Google Pay abbricht.
addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(GooglePayEventsEnum.Failed, ...)
Wird ausgelöst, wenn Google Pay fehlschlägt.
addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Loaded, ...)
Wird ausgelöst, wenn PaymentFlow erstellt wurde und zur Anzeige bereit ist.
addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)
Wird ausgelöst, wenn PaymentFlow nicht erstellt werden konnte.
addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Opened, ...)
Wird ausgelöst, wenn die PaymentFlow-Oberfläche angezeigt wird.
addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Completed, ...)
Wird nach der Bestätigung der erfassten Zahlungsdaten ausgelöst.
addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Canceled, ...)
Wird ausgelöst, wenn der Kunde PaymentFlow schließt.
addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Failed, ...)
Wird ausgelöst, wenn das Erfassen oder Bestätigen mit PaymentFlow fehlschlägt.
addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(PaymentFlowEventsEnum.Created, ...)
Wird nach dem Erfassen der Zahlungsdaten und vor ihrer Bestätigung ausgelöst. Die
Kartennummer enthält nur die letzten vier Ziffern.
addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>
method addListener(PaymentSheetEventsEnum.Loaded, ...)
Wird ausgelöst, wenn PaymentSheet erstellt wurde und zur Anzeige bereit ist.
addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)
Wird ausgelöst, wenn PaymentSheet nicht erstellt werden konnte.
addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
method addListener(PaymentSheetEventsEnum.Completed, ...)
Wird ausgelöst, wenn der Kunde PaymentSheet erfolgreich abschließt.
addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentSheetEventsEnum.Canceled, ...)
Wird ausgelöst, wenn der Kunde PaymentSheet schließt.
addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(PaymentSheetEventsEnum.Failed, ...)
Wird ausgelöst, wenn PaymentSheet mit einem Fehler endet.
addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Interfaces
Geerbte PaymentSheet- und PaymentFlow-Optionen
CreatePaymentSheetOption und CreatePaymentFlowOption erweitern das exportierte BasePaymentOption. Die docgen-Metadaten expandieren geerbte Felder nicht, daher werden sie hier ausdrücklich aufgeführt.
| Eigenschaft | Typ | Plattform / Zweck |
|---|---|---|
defaultBillingDetails |
DefaultBillingDetails |
iOS und Android |
shippingDetails |
AddressDetails |
Android |
billingDetailsCollectionConfiguration |
BillingDetailsCollectionConfiguration |
iOS und Android |
customerEphemeralKeySecret |
string |
Mit customerId verwenden |
customerId |
string |
Stripe-Customer |
enableApplePay |
boolean |
Natives PaymentSheet |
applePayMerchantId |
string |
Erforderlich bei aktiviertem Apple Pay |
enableGooglePay |
boolean |
Natives PaymentSheet |
GooglePayIsTesting |
boolean |
Android-Google-Pay-Testmodus |
countryCode |
string |
Wallet-Land, Standard US |
merchantDisplayName |
string |
PaymentSheet-Händlername |
returnURL |
string |
Weiterleitungsbasierte iOS-Authentifizierung |
paymentMethodLayout |
'horizontal' | 'vertical' | 'automatic' |
Android |
style |
'alwaysLight' | 'alwaysDark' |
iOS |
withZipCode |
boolean |
Web |
currencyCode |
string |
Google Pay mit nativem SetupIntent |
Dies sind optionale Felder. Kombinationen und Web-Einschränkungen beschreiben PaymentSheet und PaymentFlow.
interface StripeInitializationOptions
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
publishableKey |
string |
Veröffentlichbarer Stripe-Schlüssel für das Konto, das die clientseitige Zahlungsoberfläche erstellt. Niemals einen geheimen Schlüssel an die Clientanwendung übergeben. | 3.0.0 |
stripeAccount |
string |
Kennung des verbundenen Kontos, die für clientseitige Aufrufe im Namen eines Stripe-Connect-Kontos verwendet wird. | 3.0.0 |
interface StripeURLHandlingOptions
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
url |
string |
Vollständige von der Anwendung empfangene Callback-URL. | 4.0.0 |
interface CreatePaymentSheetOption
| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
paymentIntentClientSecret |
string |
Client Secret des zu bestätigenden PaymentIntent. Genau einen der Werte paymentIntentClientSecret oder setupIntentClientSecret angeben. |
3.0.0 | |
setupIntentClientSecret |
string |
Client Secret des SetupIntent zum Speichern einer Zahlungsmethode. Genau einen der Werte paymentIntentClientSecret oder setupIntentClientSecret angeben. |
3.0.0 | |
defaultBillingDetails |
DefaultBillingDetails |
Rechnungsdaten zur Vorbelegung von PaymentSheet. Nur iOS und Android. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details | 7.2.0 | |
shippingDetails |
AddressDetails |
Versanddaten zur Vorbelegung von PaymentSheet. Nur Android; unter iOS stattdessen das Adresselement von Stripe verwenden. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses | 7.2.0 | |
billingDetailsCollectionConfiguration |
BillingDetailsCollectionConfiguration |
Legt fest, welche Rechnungsdaten PaymentSheet erfasst. Nur iOS und Android. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection | 7.2.0 | |
customerEphemeralKeySecret |
string |
Vom Server zurückgegebenes Secret des temporären Kundenschlüssels. Zusammen mit customerId verwenden; nicht nur einen der beiden Werte angeben. |
3.0.0 | |
customerId |
string |
Dem customerEphemeralKeySecret zugeordnete Stripe-Kundenkennung. |
3.0.0 | |
enableApplePay |
boolean |
Aktiviert Apple Pay im nativen PaymentSheet. Nur iOS. | false | 3.3.0 |
applePayMerchantId |
string |
Für die App konfigurierte Apple-Händlerkennung. Erforderlich, wenn enableApplePay true ist; andernfalls wird sie ignoriert. |
3.3.0 | |
enableGooglePay |
boolean |
Aktiviert Google Pay im nativen PaymentSheet. Nur Android. | false | 3.2.0 |
GooglePayIsTesting |
boolean |
Verwendet die Google-Pay-Testumgebung. Nur Android. | false | 3.2.0 |
countryCode |
string |
Von Apple Pay oder Google Pay verwendeter zweibuchstabiger ISO-3166-1-Ländercode. Wird ignoriert, wenn keine der beiden Wallets aktiviert ist. | "US" | 3.2.0 |
merchantDisplayName |
string |
Im nativen PaymentSheet angezeigter Händlername. | "App Name" | 3.0.0 |
returnURL |
string |
Benutzerdefiniertes URL-Schema für die Rückkehr zur App nach einer Authentifizierung mit Weiterleitung. Nur iOS. | "" | 3.0.0 |
paymentMethodLayout |
'automatic' | 'horizontal' | 'vertical' |
Layout für die Anzeige von Zahlungsmethoden in PaymentSheet auf iOS und Android. | "automatic" | 7.2.2 |
style |
'alwaysLight' | 'alwaysDark' |
Abweichende Darstellungseinstellungen für das native PaymentSheet. Nur iOS. | undefined | 3.0.0 |
withZipCode |
boolean |
Zeigt im Web-Kartenformular das Postleitzahlfeld an. Nur Web. | true | 3.6.0 |
currencyCode |
string |
Von Google Pay verwendeter dreibuchstabiger ISO-4217-Währungscode. Erforderlich, wenn Google Pay für einen SetupIntent aktiviert ist. | "USD" | 7.1.0 |
interface CreatePaymentFlowOption
| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
paymentIntentClientSecret |
string |
Client Secret des zu bestätigenden PaymentIntent. Genau einen der Werte paymentIntentClientSecret oder setupIntentClientSecret angeben. |
3.0.2 | |
setupIntentClientSecret |
string |
Client Secret des SetupIntent zum Speichern einer Zahlungsmethode. Genau einen der Werte paymentIntentClientSecret oder setupIntentClientSecret angeben. |
3.0.2 | |
defaultBillingDetails |
DefaultBillingDetails |
Rechnungsdaten zur Vorbelegung von PaymentSheet. Nur iOS und Android. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details | 7.2.0 | |
shippingDetails |
AddressDetails |
Versanddaten zur Vorbelegung von PaymentSheet. Nur Android; unter iOS stattdessen das Adresselement von Stripe verwenden. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses | 7.2.0 | |
billingDetailsCollectionConfiguration |
BillingDetailsCollectionConfiguration |
Legt fest, welche Rechnungsdaten PaymentSheet erfasst. Nur iOS und Android. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection | 7.2.0 | |
customerEphemeralKeySecret |
string |
Vom Server zurückgegebenes Secret des temporären Kundenschlüssels. Zusammen mit customerId verwenden; nicht nur einen der beiden Werte angeben. |
3.0.0 | |
customerId |
string |
Dem customerEphemeralKeySecret zugeordnete Stripe-Kundenkennung. |
3.0.0 | |
enableApplePay |
boolean |
Aktiviert Apple Pay im nativen PaymentSheet. Nur iOS. | false | 3.3.0 |
applePayMerchantId |
string |
Für die App konfigurierte Apple-Händlerkennung. Erforderlich, wenn enableApplePay true ist; andernfalls wird sie ignoriert. |
3.3.0 | |
enableGooglePay |
boolean |
Aktiviert Google Pay im nativen PaymentSheet. Nur Android. | false | 3.2.0 |
GooglePayIsTesting |
boolean |
Verwendet die Google-Pay-Testumgebung. Nur Android. | false | 3.2.0 |
countryCode |
string |
Von Apple Pay oder Google Pay verwendeter zweibuchstabiger ISO-3166-1-Ländercode. Wird ignoriert, wenn keine der beiden Wallets aktiviert ist. | "US" | 3.2.0 |
merchantDisplayName |
string |
Im nativen PaymentSheet angezeigter Händlername. | "App Name" | 3.0.0 |
returnURL |
string |
Benutzerdefiniertes URL-Schema für die Rückkehr zur App nach einer Authentifizierung mit Weiterleitung. Nur iOS. | "" | 3.0.0 |
paymentMethodLayout |
'automatic' | 'horizontal' | 'vertical' |
Layout für die Anzeige von Zahlungsmethoden in PaymentSheet auf iOS und Android. | "automatic" | 7.2.2 |
style |
'alwaysLight' | 'alwaysDark' |
Abweichende Darstellungseinstellungen für das native PaymentSheet. Nur iOS. | undefined | 3.0.0 |
withZipCode |
boolean |
Zeigt im Web-Kartenformular das Postleitzahlfeld an. Nur Web. | true | 3.6.0 |
currencyCode |
string |
Von Google Pay verwendeter dreibuchstabiger ISO-4217-Währungscode. Erforderlich, wenn Google Pay für einen SetupIntent aktiviert ist. | "USD" | 7.1.0 |
interface CreateApplePayOption
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
paymentIntentClientSecret |
string |
Client Secret des mit Apple Pay zu bestätigenden PaymentIntent. | 3.1.0 |
paymentSummaryItems |
PaymentSummaryItem[] |
Im Apple-Pay-Dialog angezeigte Positionen. | 3.1.0 |
merchantIdentifier |
string |
Für die App konfigurierte Apple-Händlerkennung. | 3.1.0 |
countryCode |
string |
Zweibuchstabiger ISO-3166-1-Ländercode für die Zahlungsanfrage. | 3.1.0 |
currency |
string |
Dreibuchstabiger ISO-4217-Währungscode für die Zahlungsanfrage. | 3.1.0 |
requiredShippingContactFields |
('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[] |
Felder des Versandkontakts, die Apple Pay erfassen muss. Nur iOS. | 4.1.0 |
allowedCountries |
string[] |
Zweibuchstabige Ländercodes, für die Versand möglich ist. Nur iOS. | 5.4.3 |
allowedCountriesErrorDescription |
string |
Meldung, wenn das gewählte Versandland nicht erlaubt ist. Nur iOS. | 5.4.3 |
interface CreateGooglePayOption
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
paymentIntentClientSecret |
string |
Client Secret des mit Google Pay zu bestätigenden PaymentIntent. | 3.2.0 |
paymentSummaryItems |
{ label: string; amount: number; }[] |
Nur Web. Erfordert stripe-pwa-elements ^3.0.0. | 3.2.0 |
merchantIdentifier |
string |
Nur Web. Erfordert stripe-pwa-elements ^3.0.0. | 3.2.0 |
countryCode |
string |
Nur Web. Erfordert stripe-pwa-elements ^3.0.0. | 3.2.0 |
currency |
string |
Nur Web. Erfordert stripe-pwa-elements ^3.0.0. | 3.2.0 |
interface PaymentSummaryItem
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
label |
string |
Im Apple-Pay-Dialog angezeigte Bezeichnung der Position. | 3.1.0 |
amount |
number |
Dezimalbetrag in der Haupteinheit der Währung, beispielsweise 10.99. |
3.1.0 |
interface DefaultBillingDetails
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
email |
string |
Vorbelegte E-Mail-Adresse für die Rechnung. | 7.2.0 |
name |
string |
Vorbelegter Name für die Rechnung. | 7.2.0 |
phone |
string |
Vorbelegte Telefonnummer für die Rechnung. | 7.2.0 |
address |
Address |
Vorbelegte Rechnungsadresse. | 7.2.0 |
interface Address
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
country |
string |
Zweibuchstabiger Ländercode (ISO 3166-1 alpha-2). | 7.2.0 |
city |
string |
Stadt, Bezirk, Vorort, Ort oder Dorf. | 7.2.0 |
line1 |
string |
Erste Adresszeile, etwa eine Straßenadresse oder ein Postfach. | 7.2.0 |
line2 |
string |
Zweite Adresszeile, etwa eine Wohnungs- oder Büronummer. | 7.2.0 |
postalCode |
string |
Postleitzahl. | 7.2.0 |
state |
string |
Bundesland, Bezirk, Provinz oder Region. | 7.2.0 |
interface AddressDetails
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
name |
string |
Name des Empfängers. | 7.2.0 |
address |
Address |
Postadresse des Empfängers. | 7.2.0 |
phone |
string |
Telefonnummer des Empfängers. | 7.2.0 |
isCheckboxSelected |
boolean |
Ob der Kunde das Kontrollkästchen zum Speichern der Adresse ausgewählt hat. Nur Android. | 7.2.0 |
interface BillingDetailsCollectionConfiguration
Legt fest, welche Rechnungsdaten PaymentSheet vom Kunden erfasst.
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
email |
CollectionMode |
Modus für die Erfassung der E-Mail-Adresse. | 5.4.0 |
name |
CollectionMode |
Modus für die Erfassung des Namens. | 5.4.0 |
phone |
CollectionMode |
Modus für die Erfassung der Telefonnummer. | 5.4.0 |
address |
AddressCollectionMode |
Modus für die Erfassung der Postadresse. | 5.4.0 |
interface DidSelectShippingContact
Apple-Pay-Daten des Versandkontakts.
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
contact |
ShippingContact |
In Apple Pay ausgewählter Versandkontakt. | 4.1.0 |
updateId |
string |
Für diesen Callback an updateApplePaySheet() übergebene Kennung. |
4.1.0 |
interface DidCreatePaymentMethod
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
contact |
ShippingContact |
Der Apple-Pay-Zahlungsmethode zugeordneter Kontakt. | 4.1.0 |
interface ShippingContact
| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
givenName |
string |
Vorname des Kontakts. Nur Apple Pay. | 4.1.0 |
familyName |
string |
Nachname des Kontakts. Nur Apple Pay. | 4.1.0 |
middleName |
string |
Zweiter Vorname des Kontakts. Nur Apple Pay. | 4.1.0 |
namePrefix |
string |
Namenspräfix des Kontakts. Nur Apple Pay. | 4.1.0 |
nameSuffix |
string |
Namenssuffix des Kontakts. Nur Apple Pay. | 4.1.0 |
nameFormatted |
string |
Formatierter vollständiger Name des Kontakts. Nur Apple Pay. | 4.1.0 |
phoneNumber |
string |
Telefonnummer des Kontakts. Nur Apple Pay. | 4.1.0 |
nickname |
string |
Spitzname des Kontakts. Nur Apple Pay. | 4.1.0 |
street |
string |
Straßenbestandteil der Postadresse des Kontakts. Nur Apple Pay. | 4.1.0 |
city |
string |
Ortsbestandteil der Postadresse des Kontakts. Nur Apple Pay. | 4.1.0 |
state |
string |
Bundesland- oder Provinzbestandteil der Postadresse des Kontakts. Nur Apple Pay. | 4.1.0 |
postalCode |
string |
Postleitzahlbestandteil der Adresse des Kontakts. Nur Apple Pay. | 4.1.0 |
country |
string |
Länder- oder Regionsname in der Adresse des Kontakts. Nur Apple Pay. | 4.1.0 |
isoCountryCode |
string |
ISO-Ländercode in der Adresse des Kontakts. Nur Apple Pay. | 4.1.0 |
subAdministrativeArea |
string |
Untergeordneter Verwaltungsbereich in der Adresse des Kontakts. Nur Apple Pay. | 4.1.0 |
subLocality |
string |
Untergeordneter Ortsbereich in der Adresse des Kontakts. Nur Apple Pay. | 4.1.0 |
interface PluginListenerHandle
| Eigenschaft | Typ |
|---|---|
remove |
() => Promise<void> |
Typaliase
type alias PaymentSheetResultInterface
PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed
type alias PaymentFlowResultInterface
PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed
type alias ApplePayResultInterface
ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod
type alias GooglePayResultInterface
GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed
type alias CollectionMode
'automatic' | 'always' | 'never'
type alias AddressCollectionMode
'automatic' | 'full' | 'never'
Enums
enum PaymentSheetEventsEnum
| Mitglied | Wert |
|---|---|
Loaded |
'paymentSheetLoaded' |
FailedToLoad |
'paymentSheetFailedToLoad' |
Completed |
'paymentSheetCompleted' |
Canceled |
'paymentSheetCanceled' |
Failed |
'paymentSheetFailed' |
enum PaymentFlowEventsEnum
| Mitglied | Wert |
|---|---|
Loaded |
'paymentFlowLoaded' |
FailedToLoad |
'paymentFlowFailedToLoad' |
Opened |
'paymentFlowOpened' |
Created |
'paymentFlowCreated' |
Completed |
'paymentFlowCompleted' |
Canceled |
'paymentFlowCanceled' |
Failed |
'paymentFlowFailed' |
enum ApplePayEventsEnum
| Mitglied | Wert |
|---|---|
Loaded |
'applePayLoaded' |
FailedToLoad |
'applePayFailedToLoad' |
Completed |
'applePayCompleted' |
Canceled |
'applePayCanceled' |
Failed |
'applePayFailed' |
DidSelectShippingContact |
'applePayDidSelectShippingContact' |
DidCreatePaymentMethod |
'applePayDidCreatePaymentMethod' |
enum GooglePayEventsEnum
| Mitglied | Wert |
|---|---|
Loaded |
'googlePayLoaded' |
FailedToLoad |
'googlePayFailedToLoad' |
Completed |
'googlePayCompleted' |
Canceled |
'googlePayCanceled' |
Failed |
'googlePayFailed' |