Zum Hauptinhalt springen
Das PapelShip JavaScript SDK bindet das PapelPay-Kartenformular in Ihre eigene Checkout-Seite ein, sodass der Kunde Ihre Website nie verlässt. Das Formular wird in einem Frame von PapelShip geladen: Kartendaten erreichen niemals Ihren Server oder Ihre Seite.

Bevor Sie beginnen

  • Starten Sie die Kartenzahlung auf Ihrem Server mit POST /api/v1/invoices/{invoiceId}/papelpay und übergeben Sie payment.embed_url an Ihre Seite. Siehe Überblick.
  • Fügen Sie die Domain Ihrer Checkout-Seite im Dashboard unter PapelPay > Domains hinzu und verifizieren Sie sie. Eine verifizierte benutzerdefinierte Domain Ihres Shops funktioniert ebenfalls, ebenso deren Subdomains.
  • localhost und 127.0.0.1 funktionieren während der Entwicklung ohne Einrichtung.
Auf einer nicht verifizierten Domain zeigt der Frame statt des Formulars einen Hinweis an, und onError erhält origin_not_allowed.

Formular einbinden

checkout.html
Der Frame wächst und schrumpft mit seinem Inhalt. mount liefert { iframe, destroy }; rufen Sie card.destroy() auf, um das Formular zu entfernen, zum Beispiel wenn der Kunde eine andere Zahlungsmethode wählt.

Optionen

Ereignisse

Dieselben Ereignisse sind global über PapelShip.on("papelpay:paid", fn), papelpay:declined, papelpay:error und papelpay:ready verfügbar sowie als CustomEvents papelship:papelpay:paid (und so weiter) auf window.

Zahlung auf Ihrem Server bestätigen

onPaid teilt Ihrer Seite mit, dass die Karte belastet wurde. Bevor Sie selbst etwas ausliefern, bestätigen Sie die Bestellung auf Ihrem Server: Warten Sie auf den Webhook order.completed oder rufen Sie GET /api/v1/invoices/{invoiceId} ab und prüfen Sie, ob status den Wert completed hat. Siehe Webhooks.
Erlauben Sie Kartenzahlungsfunktionen im übergeordneten Element des Frames, wenn Sie eine eigene iframe-Sandbox oder Permissions Policy verwenden: Das SDK setzt für Wallet-Zahlungen allow="payment *" auf seinem Frame.