Zum Hauptinhalt springen
PapelPay ist die Kartenzahlungsmethode Ihres PapelShip Shops. Mit der Store API erstellen Sie eine Bestellung, starten deren PapelPay-Zahlung und lassen den Kunden per Karte in Ihrem gehosteten Checkout oder in einem Kartenformular auf Ihrer eigenen Website bezahlen. Bestellungen für Produkte, die als Abonnement verkauft werden, werden in jedem Abrechnungszeitraum erneut belastet.
PapelPay muss in Ihrem Shop aktiv sein. Beantragen Sie es im Dashboard unter PapelPay; die Endpunkte auf dieser Seite liefern PAPELPAY_NOT_ENABLED, bis Ihr Shop freigeschaltet ist.

So funktioniert eine Kartenzahlung

1

Bestellung erstellen

Rufen Sie POST /api/v1/invoices mit dem Kunden und den Produkten auf, wie unter Bestellungen erstellen und verwalten beschrieben. Fügen Sie auto_renew hinzu, um ein Abonnementprodukt als Abonnement oder als Einmalkauf zu verkaufen. Siehe Abonnements.
2

Kartenzahlung starten

Rufen Sie POST /api/v1/invoices/{invoiceId}/papelpay auf oder senden Sie beim Erstellen der Bestellung "payment_method": "PAPELPAY", um beides in einem Aufruf zu erledigen. Die Antwort enthält ein payment-Objekt.
3

Kunden bezahlen lassen

Leiten Sie den Kunden zu payment.payment_url weiter, Ihrem gehosteten Checkout, der direkt mit dem Kartenformular geöffnet wird. Um den Kunden auf Ihrer Website zu halten, binden Sie payment.embed_url mit dem JavaScript SDK ein. Siehe Kartenformular auf Ihrer Website.
4

Bestellung bestätigen

Sobald die Karte belastet wurde, wechselt die Bestellung zu completed und PapelShip liefert die Produkte aus. Warten Sie auf den Webhook order.completed oder rufen Sie die Bestellung mit GET /api/v1/invoices/{invoiceId} ab. Siehe Webhooks.

Kartenzahlung starten

Antwort (200)
Ein erneuter Aufruf des Endpunkts, während die Zahlung offen ist, liefert dieselbe session_id. Verwenden Sie die Bestell-ID in Ihrem Idempotency-Key.

Das Payment-Objekt

Fehler

Wenn Sie beim Erstellen "payment_method": "PAPELPAY" senden und die Kartenzahlung nicht gestartet werden kann, existiert die Bestellung trotzdem. details.invoice_id im Fehler nennt sie, sodass Sie es mit POST /invoices/{invoiceId}/papelpay erneut versuchen können.

Nächste Schritte

Abonnements

Verkaufen Sie ein Produkt als Abonnement und verfolgen Sie dessen Verlängerungen.

Kartenformular auf Ihrer Website

Zeigen Sie das Kartenformular auf Ihrer eigenen Checkout-Seite an.