AccessPass.requestPurchaseIfNeeded()
AccessPass.requestPurchaseIfNeeded({ amount, name, productId, statementDescriptor, accessDurationDays, currency, language })
Beschreibung
Öffnet ein Kassenfenster, in dem der Kunde eine sichere Zahlung für den bereitgestellten Zugangspass vornehmen kann.
Wenn in der Vergangenheit bereits ein gültiger Zugangspass gekauft wurde, wird die zurückgegebene Versprechen sofort mit Informationen über den vorherigen Kauf aufgelöst.
Alle Parameter, die über diese API bereitgestellt werden, ersetzen alle Parameter, die in der Modulkonfiguration angegeben wurden.
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
amount | Nummer | Der Betrag, der für die Zahlung des angegebenen Zugangspasses angefordert werden soll. Die Beträge haben ein jeweiliges Minimum und Maximum, wie durch die Währung definiert.AUD: $0,99 bis $99,99 CAD: $0,99 bis $99,99 GBP: £0,99 bis £99,99 JPY: ¥99 bis ¥999 NZD: $0,99 bis $99,99 USD: $0,99 bis $99,99 |
name | String | Der Name des Produkts. Dies wird dem Benutzer auf dem Kassenbildschirm angezeigt. Maximal 30 Zeichen. |
productId | String | Eine eindeutige Kennung für diesen Zugangspass. Maximal 30 Zeichen. |
statementDescriptor | String | Die Bezeichnung, die auf der Kreditkartenabrechnung des Kunden erscheint. Maximal 22 Zeichen. |
accessDurationDays | Nummer | Die Anzahl der Tage, für die ein Kunde Zugang hat. Minimum von 1 und Maximum von 7. |
currency | String | Die Währung, die dem Benutzer in Rechnung gestellt wird. Kann 'aud ', 'cad ', 'gbp ', 'jpy ', 'nzd ', oder 'usd ' sein. |
language | String | Die Sprache, die dem Endbenutzer auf der sicheren Kassenseite angezeigt wird. Kann 'en-US ' (Englisch - Vereinigte Staaten) oder 'ja-JP ' (Japanisch) sein. |
Returns
Ein Versprechen, das aufgelöst wird, wenn der Kunde den Kauf erfolgreich abgeschlossen hat. Das Ergebnis enthält Informationen über den getätigten Kauf:
{
productId: '1-day-access-pass',
timestamp: 1653413347810,
expirationTimestamp: 1653499747810,
}
Wirft
Ein Fehler wird ausgelöst, wenn der Kunde den Kauf nicht erfolgreich abschließt.
Beispiel
AccessPass.requestPurchaseIfNeeded({
amount: 9.99,
name: '1-Day Access Pass',
productId: '1-day-access-pass',
statementDescriptor: '1DAY ACCESS PASS',
accessDurationDays: 1,
currency: 'usd',
language: 'en-US',
})