Gateway erstellen
Schritt-für-Schritt-Anleitung zum Erstellen und Abschliessen einer Gateway-Zahlung.
zahls.ch kommt ins Spiel, sobald dein Käufer die Daten auf deiner Website übermittelt und die Zahlung startet.
Gateway erstellen
Lies die API-Referenz für alle nötigen Informationen.
Du lernst die Grundlagen von API-Requests bei zahls.ch und kannst mit dem Erstellen eines Gateways weitermachen.
Payload
Neben den Pflichtdaten kannst du frei wählen, was du an zahls.ch übermitteln möchtest.
Hier einige Parameter, die für dich interessant sein könnten:
| Parameter | Data Type | Description |
|---|---|---|
| successRedirectUrl | string | Nach erfolgreicher Zahlung Weiterleitung auf diese URL. Muss URL-kodiert sein. |
| failedRedirectUrl | string | Nach fehlgeschlagener Zahlung Weiterleitung auf diese URL. Muss URL-kodiert sein. |
| cancelRedirectUrl | string | Nach abgebrochener Zahlung Weiterleitung auf diese URL. Muss URL-kodiert sein. |
| basket | array | Liste aller Produktpositionen. Für E-Mail-Benachrichtigungen und Rechnungen |
| pm | string[] | Verfügbare Zahlungsmittel einschränken mit den passenden Kennungen |
| preAuthorization | bool | Tokenisierung-Zahlung verarbeiten |
| reservation | bool | Vorautorisierungs-Zahlung verarbeiten |
| referenceId | string | Zum späteren Zuordnen der zahls.ch-Transaktion zu einer Bestellung |
| fields | array | Kundendaten |
| skipResultPage | bool | zahls.ch-Ergebnisseite überspringen Hinweis: Wird ein Gateway mit skipResultPage erstellt und in einer iFrame-Integration genutzt, muss am Gateway-Link &appview=1 angehängt werden |
| chargeOnAuthorization | bool | Tokenisierung – Erste Belastung direkt nach der Autorisierung |
| validity | int | Wie lange dein Payment Gateway verfügbar sein soll |
| subscriptionState | bool | Auf true setzen für Abonnements |
| subscriptionInterval | string | Abonnement – Zahlungsintervall (PHP-Intervallspezifikation) |
| subscriptionPeriod | string | Abonnement – Laufzeit (PHP-Intervallspezifikation) |
| subscriptionCancellationInterval | string | Abonnement – Dauer der Kündigungsmöglichkeit (PHP-Intervallspezifikation) |
| lookAndFeelProfile | string | Bei mehreren Look-&-Feel-Profilen: welches verwendet werden soll |
Alle möglichen Felder
- title
- forename
- surname
- company
- street
- postcode
- place
- country
- delivery_title
- delivery_forename
- delivery_surname
- delivery_company
- delivery_street
- delivery_postcode
- delivery_place
- delivery_country
- phone
- date_of_birth
- terms
- privacy_policy
- custom_field_1
- custom_field_2
- custom_field_3
- custom_field_4
- custom_field_5
Beispiele
fields[forename][value]=John
fields[lastname][value]=Doe
fields[email][value]=john@doe.com
fields[street][value]=Burgstrasse 20
fields[postcode][value]=3600
fields[place][value]=Thun
fields[country][value]=CH
Sprachen
Ist Mehrsprachigkeit im Händler-Backend aktiviert, kannst du in der API mehrere Übersetzungen für die Attribute Name und Description übergeben.
Jede Sprache wird über eine ID identifiziert:
| ID | Language |
|---|---|
| 1 | German |
| 2 | English |
| 3 | French |
| 4 | Italian |
| 7 | Dutch |
| 8 | Portuguese |
| 9 | Turkish |
| 10 | Polish |
| 11 | Spanish |
| 12 | Danish |
| 13 | Swedish |
| 14 | Norwegian |
Beispiele
# Without translation
fields[custom_field_1][name]=Fieldname
# With German and English translation
fields[custom_field_1][name][1]=Feldname
fields[custom_field_1][name][2]=Fieldname
Antwort
Nach erfolgreichem Erstellen des Gateways erhältst du in der Antwort einen Link.
Leite den Käufer zu diesem Link weiter, um die Zahlung abzuwickeln.
Zahlung
Dein Käufer wählt im Gateway ein Zahlungsmittel und führt die Zahlung aus:
Nach der Zahlung
Der Käufer wird je nach Ergebnis des Zahlungsprozesses auf die passende URL weitergeleitet (success-/cancel-/failedRedirectUrl).
Nächste Schritte
Als Nächstes führst du je nach Zahlungsergebnis weitere Schritte aus.