Multiexcerpt includeSpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
-Schnittstelle
SpaceWithExcerpt | DE |
---|---|
MultiExcerptName | Platform-Name |
PageWithExcerpt | Wording |
Abfrage verfügbarer Zahlungsarten (Zwei-Schritt-Autorisierung)
AfterPay unterscheidet zwischen der Ein-Schritt- und Zwei-Schritt-Autorisierung. Die Ein-Schritt-Autorisierung dient Händlern, die nur die normale Zahlung per Rechnung in ihrem Checkout nutzen. Die Zwei-Schritt-Autorisierung ermöglicht es, für einen bestimmten Warenkorb die hierfür verfügbaren Zahlungsarten und weitere Informationen dazu abzufragen.
Um eine Zwei-Schritt-Autorisierung mit AfterPay über eine Server-zu-Server-Verbindung abzuwickeln, rufen Sie folgende URL auf:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||
TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss | ||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | ||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den | ||||||||
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217 | ||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||
EventToken | a..19 | M | Bei Übergabe von „PAYMENTMETHODS“ wird der Zwei-Schritt-Prozess durchlaufen. | ||||||||
bdCompanyOrPerson | a..7 | O | Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert) | ||||||||
SocialSecurityNumber | ans..16 | C | Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. | ||||||||
AddrCountryCode | a2 | M | Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” | ||||||||
AddrZip | ans..10 | C | Postleitzahl Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL, NO Optional: AT, BE, CH, FI, SE | ||||||||
AddrStreet | ans..80 | C | Straße oder Packstation Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL Optional: AT, BE, CH, FI, NO, SE | ||||||||
AddrStreetNr | a..50 | C | Haus- oder Packstationsnummer Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DK, NL Optional: AT, BE, CH, DE, FI, NO, SE | ||||||||
AddrStreetNr2 | ans..10 | C | Straßennummernzusatz Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DK, NL Optional: AT, BE, CH, DE, FI, NO, SE | ||||||||
AddrCity | ans..100 | C | Ort Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL Optional: AT, BE, CH, FI, NO, SE | ||||||||
FirstName | ans..50 | O | Vorname | ||||||||
LastName | ans..50 | O | Nachname | ||||||||
CustomerID | ans..20 | O | Eindeutige Kundennummer | ||||||||
Salutation | a..4 | C | Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Pflicht: NL, BE Optional: AT, BE, CH, DE, DK, FI, NO, SE | ||||||||
bdEmail | ans..100 | C | E-Mail-Adresse ist optional für normale Autorisierungsanfragen. Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: AT, BE, CH, DE, FI, NL, SE Optional: DK, NO | ||||||||
bdPhone | ns..20 | O | Telefonnummer | ||||||||
bdMobileNo | ns..20 | O | Handynummer | ||||||||
DateOfBirth | an10 | O | Geburtsdatum im Format YYYY-MM-DD. Für Firmen nicht zutreffend. Pflicht: AT, BE, CH, DK, NL Optional: DE, FI, NO, SE | ||||||||
CustomerRisk | ans..1024 | O | Risikorelevante Daten als JSON-String im Base64-Format (siehe JSON-Objekte / CustomerRisk) Händler können externe Risikoprüfungen durchführen und AfterPay diese Informationen zusenden. Gültig bei AddrCountryCode = „DE“ | ||||||||
Language | a2 | O | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig | ||||||||
CompanyOrPerson | a..7 | O | Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) | ||||||||
sdCountryCode | a2 | O | Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” | ||||||||
sdZip | ans..10 | O | Postleitzahl der Lieferadresse | ||||||||
sdStreet | ans..80 | O | Straße oder Packstation der Lieferadresse | ||||||||
sdStreetNr | a..50 | O | Haus- oder Packstationsnummer der Lieferadresse | ||||||||
sdStreetNr2 | ans..10 | O | Straßennummernzusatz der Lieferadresse | ||||||||
sdCity | ans..100 | O | Ort der Lieferadresse | ||||||||
sdFirstName | ans..50 | O | Vorname der Lieferadresse | ||||||||
sdLastName | ans..50 | O | Nachname der Lieferadresse | ||||||||
sdSalutation | a..4 | O | Anrede der Lieferadresse „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Gültig bei AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ oder „CH“ | ||||||||
ans..100 | O | E-Mail-Adresse der Lieferadresse | |||||||||
Phone | ns..50 | O | Telefonnummer der Lieferadresse | ||||||||
MobileNo | ns..50 | O | Handynummer der Lieferadresse | ||||||||
Order | ans..1024 | M | Bestellinformationen als JSON-String im Base64-Format. Siehe JSON-Objekt / Order |
Parameter für Zahlungen mit AfterPay
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das
an Ihr System zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | |||||||||
Status | a..50 | M | AUTHORIZE_REQUEST oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..1024 | O | Fehlertext von AfterPay, wenn mit | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate | |||||||||
AllowedPayMethods | ans..1024 | O | Erlaubte Zahlungsarten als JSON-String im Base64-Format. (siehe JSON-Objekte / AllowedPayMethods) | |||||||||
BillingAddress | ans..1024 | O | Ggfls. korrigierte Rechnungsadresse als JSON-String im Base64-Format. (siehe JSON-Objekte / Address) | |||||||||
ShippingAddress | ans..1024 | O | Ggfls. korrigierte Lieferadresse als JSON-String im Base64-Format. (siehe JSON-Objekte / Address) |
Ergebnis-Parameter für AfterPay
Im zweiten Schritt werden die zu verwendende Zahlungsart und evtl. weitere zur Zahlungsart gehörende Informationen übergeben. Die Übergabe der Kunden- und Bestelldaten ist nicht mehr notwendig, da sie bereits im ersten Schritt übergeben wurden.
Um den zweiten Schritt durchzuführen, Rufen Sie folgende URL auf:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||
PayID | an32 | M | Vom | ||||||||
TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss | ||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | ||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||||||||
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217 | ||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||
PayType | a..19 | M | Zahlungsmethode: „Invoice“ für Rechnung | ||||||||
BIC | ans..11 | O | Bank Identifier Code (Gültig bei AddrCountryCode = “DE”) | ||||||||
IBAN | ans..34 | O | International Bank Account Number (Gültig bei AddrCountryCode = “DE”) | ||||||||
ProductNr | n..8 | C | Profilnummer Pflicht, wenn PayType = „Account“ oder „Installment“ | ||||||||
InvoiceDate | an10 | O | Datum der Rechnungsstellung im Format YYYY-MM-DD. Nur bei PayType = „ConsolidatedInvoice“ |
Parameter für AfterPay
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das
an Ihr System zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | |||||||||
Status | a..50 | M | AUTHORIZE_REQUEST oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..1024 | O | Fehlertext von AfterPay, wenn mit | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | |||||||||
AllowedPayMethods | ans..1024 | O | Erlaubte Zahlungsarten als JSON-String im Base64-Format. (siehe JSON-Objekte / AllowedPayMethods) |
Ergebnis-Parameter für AfterPay
Aufruf der Schnittstelle für Ein-Schritt-Autorisierung
Um eine Ein-Schritt-Autorisierung mit AfterPay abzuwickeln, rufen Sie folgende URL auf:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||
TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss | ||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | ||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den | ||||||||
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217 | ||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||
PayType | a..19 | M | Zahlungsmethode: „Invoice“ für Rechnung | ||||||||
BIC | ans..11 | O | Bank Identifier Code (Gültig bei AddrCountryCode = “DE”) | ||||||||
IBAN | ans..34 | O | International Bank Account Number (Gültig bei AddrCountryCode = “DE”) | ||||||||
ProductNr | n..8 | C | Profilnummer Pflicht, wenn PayType = „Account“ oder „Installment“ | ||||||||
InvoiceDate | an10 | O | Datum der Rechnungsstellung im Format YYYY-MM-DD. Nur bei PayType = „ConsolidatedInvoice“ | ||||||||
bdCompanyOrPerson | a..7 | O | Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert) | ||||||||
SocialSecurityNumber | ans..16 | C | Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. | ||||||||
AddrCountryCode | a2 | M | Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” | ||||||||
AddrZip | ans..10 | C | Postleitzahl Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL, NO Optional: AT, BE, CH, FI, SE | ||||||||
AddrStreet | ans..80 | C | Straße oder Packstation Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL Optional: AT, BE, CH, FI, NO, SE | ||||||||
AddrStreetNr | a..50 | C | Haus- oder Packstationsnummer Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DK, NL Optional: AT, BE, CH, DE, FI, NO, SE | ||||||||
AddrStreetNr2 | ans..10 | C | Straßennummernzusatz Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DK, NL Optional: AT, BE, CH, DE, FI, NO, SE | ||||||||
AddrCity | ans..100 | C | Ort Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: DE, DK, NL Optional: AT, BE, CH, FI, NO, SE | ||||||||
FirstName | ans..50 | O | Vorname | ||||||||
LastName | ans..50 | O | Nachname | ||||||||
CustomerID | ans..20 | O | Eindeutige Kundennummer | ||||||||
Salutation | a..4 | O | Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Pflicht: NL, BE Optional: AT, BE, CH, DE, DK, FI, NO, SE | ||||||||
bdEmail | ans..100 | O | E-Mail-Adresse ist optional für normale Autorisierungsanfragen. Bei der Abfrage verfügbarer Zahlungsmethoden gelten folgende Bedingungen: Pflicht: AT, BE, CH, DE, FI, NL, SE Optional: DK, NO | ||||||||
bdPhone | ns..20 | O | Telefonnummer | ||||||||
bdMobileNo | ns..20 | O | Handynummer | ||||||||
DateOfBirth | an10 | O | Geburtsdatum im Format YYYY-MM-DD. Für Firmen nicht zutreffend. Pflicht: AT, BE, CH, DK, NL Optional: DE, FI, NO, SE | ||||||||
CustomerRisk | ans..1024 | O | Risikorelevante Daten als JSON-String im Base64-Format (siehe JSON-Objekte / CustomerRisk) Händler können externe Risikoprüfungen durchführen und AfterPay diese Informationen zusenden. Gültig bei AddrCountryCode = „DE“ | ||||||||
Language | a2 | O | Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig | ||||||||
CompanyOrPerson | a..7 | O | Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) | ||||||||
sdCountryCode | a2 | O | Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE” | ||||||||
sdZip | ans..10 | O | Postleitzahl der Lieferadresse | ||||||||
sdStreet | ans..80 | O | Straße oder Packstation der Lieferadresse | ||||||||
sdStreetNr | a..50 | O | Haus- oder Packstationsnummer der Lieferadresse | ||||||||
sdStreetNr2 | ans..10 | O | Straßennummernzusatz der Lieferadresse | ||||||||
sdCity | ans..100 | O | Ort der Lieferadresse | ||||||||
sdFirstName | ans..50 | O | Vorname der Lieferadresse | ||||||||
sdLastName | ans..50 | O | Nachname der Lieferadresse | ||||||||
sdSalutation | a..4 | O | Anrede der Lieferadresse „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein Gültig bei AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ oder „CH“ | ||||||||
ans..100 | O | E-Mail-Adresse der Lieferadresse | |||||||||
Phone | ns..50 | O | Telefonnummer der Lieferadresse | ||||||||
MobileNo | ns..50 | O | Handynummer der Lieferadresse | ||||||||
Order | ans..1024 | M | Bestellinformationen als JSON-String im Base64-Format. Siehe JSON-Objekt / Order |
Parameter für Zahlungen mit AfterPay
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das
an Ihr System zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | |||||||||
Status | a..50 | M | OK oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..1024 | O | Fehlertext von AfterPay, wenn mit | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | |||||||||
BillingAddress | ans..1024 | O | Ggfls. korrigierte Rechnungsadresse als JSON-String im Base64-Format. (siehe JSON-Objekte / Adresse) | |||||||||
ShippingAddress | ans..1024 | O | Ggfls. korrigierte Lieferadresse als JSON-String im Base64-Format. (siehe JSON-Objekte / Adresse) |
Ergebnis-Parameter für AfterPay
Buchung
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für AfterPay über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||||||||||
PayID | an32 | M | Vom | ||||||||||||||||
TransID | ans..18 | M | Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang | ||||||||||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den | ||||||||||||||||
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 | ||||||||||||||||
RefNr | ns..30 | O | Referenznummer des Händlers | ||||||||||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||||||||||
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc. | ||||||||||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | ||||||||||||||||
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das | ||||||||||||||||
Order | ans..1024 | C | Pflicht bei Teilbuchung oder wenn sich die Bestellinformationen bei gleichem Gesamtbetrag geändert haben. Bestellinformationen als JSON-String im Base64-Format. (siehe JSON-Objekte / OrderSummary) | ||||||||||||||||
InvoiceNr | ans..30 | O | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird. Rechnungsnummer, die im AfterPay-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten. | ||||||||||||||||
ShippingData | ans..1024 | O | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird. Versandinformationen als JSON-String im Base64-Format. (siehe JSON-Objekte / ShippingData) |
Parameter für AfterPay-Buchungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das
als Antwort zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
Status | a..50 | M | OK, CAPTURE_REQUEST oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
RefNr | ns..30 | M | Referenznummer des Händlers | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | |||||||||
InvoiceNumber | ans..30 | O | Buchungsnummer: entweder vom Merchant oder, falls nicht vorhanden, von AfterPay generiert. Wird für Teilgutschriften benötigt. | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..128 | O | Fehlermeldung von AfterPay, wenn mit |
Ergebnis-Parameter für AfterPay-Buchungen
Gutschrift mit Referenz
Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt. Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||||||||||
PayID | an32 | M | Vom | ||||||||||||||||
TransID | ans..18 | M | Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang | ||||||||||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den | ||||||||||||||||
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 | ||||||||||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||||||||||
OrderDesc | ans..768 | O | Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. | ||||||||||||||||
RefNr | ns..30 | O | Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss | ||||||||||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | ||||||||||||||||
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das | ||||||||||||||||
Order | ans..1024 | C | Pflicht bei Teilgutschriften Bestellinformationen als JSON-String im Base64-Format. (siehe JSON-Objekte / RefundOrder) | ||||||||||||||||
InvoiceNr | ans..30 | C | Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird, dann allerdings Pflicht. Rechnungsnummer, die gutgeschrieben werden soll. Dies ist die Rechnungsnummer, die in der Antwort der Buchung enthalten ist. | ||||||||||||||||
RefundType | enum | O | Art der Gutschrift: Mögliche Werte sind „Refund“ und „Return“ Wird nur bei einer kompletten Gutschrift benötigt. |
Parameter für Gutschrift von AfterPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das
als Antwort zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
Status | a..50 | M | OK oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
RefNr | ns..30 | M | Referenznummer des Händlers | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..128 | O | Fehlermeldung von AfterPay, wenn mit |
Ergebnis-Parameter für Gutschrift von AfterPay-Zahlungen
Aufruf der Schnittstelle für Stornierungen
Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei AfterPay zu stornieren, verwenden Sie bitte folgende URL:
|
Hinweis: Aus Sicherheitsgründen lehnt das
alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von | ||||||||||||||||
PayID | an32 | M | Vom | ||||||||||||||||
TransID | ans..18 | M | ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs | ||||||||||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||||||||||||||||
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 | ||||||||||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | ||||||||||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | ||||||||||||||||
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das | ||||||||||||||||
Order | ans..1024 | C | Pflicht bei Teilstornierungen Bestellinformationen als JSON-String im Base64-Format. (siehe JSON-Objekte / OrderSummary) |
Parameter für Storno von AfterPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das
als Antwort zurückgibt: Multiexcerpt include SpaceWithExcerpt DE MultiExcerptName Platform-Name PageWithExcerpt Wording
Parameter | Format | CND | Beschreibung | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von | |||||||||
PayID | an32 | M | Vom | |||||||||
XID | an32 | M | Vom | |||||||||
TransID | ans..18 | M | Transaktionsnummer des Händlers | |||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den | |||||||||
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 | |||||||||
Status | a..50 | M | OK oder FAILED | |||||||||
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |||||||||
Code | n8 | M | Fehlercode gemäß | |||||||||
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das | |||||||||
CodeExt | n..10 | O | Fehlercode von AfterPay, wenn mit | |||||||||
ErrorText | ans..128 | O | Fehlermeldung von AfterPay, wenn mit |
Ergebnis-Parameter für Storno von AfterPay-Zahlungen
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer AfterPay-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Hinweis: Beachten Sie bitte, dass keine Teil-Stornierungen, -Buchungen oder -Gutschriften über Batch für AfterPay möglich sind.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Aktion | Version | Beschreibung |
Capture | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Reverse | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2x. | mit RefNr (gilt für alle Versionen außer 1.0) |
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine AfterPay-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Beispiel für Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, AFTERPAY für AfterPay | ||||||||
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) | ||||||||
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den | ||||||||
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 | ||||||||
TransID | ans..18 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss | ||||||||
RefNr | ns..30 | O | eindeutige Referenznummer | ||||||||
PayID | an32 | M | Vom |
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter, werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) | ||||||||
PayID | an32 | M | Vom | ||||||||
Status | a..50 | M | OK oder FAILED | ||||||||
Code | n8 | M | Fehlercode gemäß |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien
JSON-Objekte
Die JavaScript Object Notation, kurz JSON, ist ein kompaktes Datenformat in einer einfach lesbaren Textform zum Zweck des Datenaustauschs zwischen Anwendungen. JSON ist unabhängig von der Programmiersprache. Parser existieren in praktisch allen verbreiteten Sprachen. Einige Informationen über JSON sind unter diesem Link zu finden:
Im Folgenden werden die JSON-Objekte beschrieben, die für Requests benötigt, oder aber in der Response zurückgeliefert werden.
Hinweis: Da der JSON-String Sonderzeichen enthalten kann, muss er zusätzlich Base64-codiert werden. Anderenfalls kann es zu Problemen bei der Übertragung kommen.
CustomerRisk
Risikorelevante Daten zum Kunden. Händler können externe Risikoprüfungen durchführen und AfterPay diese Informationen zusenden.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
existingCustomer | bool | O | Gibt an, ob der Kunde ein für den Händler bereits existierender Kunde ist |
verifiedCustomerIdentification | bool | O | Gibt an, ob der Kunde verifiziert wurde |
marketingOptIn | bool | O | Gibt an, ob Marketing-Material erwünscht ist |
customerSince | dttm | O | Datum, seit dem der Kunde existiert im Format YYYY-MM-DD |
customerClassification | ans..32 | O | Kundenklassifizierung |
acquisitionChannel | enum | O | Gibt den genutzten Kanal an, um auf die Händlerseite zu gelangen. Mögliche Werte: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other” |
hasCustomerCard | bool | O | Gibt an, ob der Kunde eine Kundenkarte besitzt |
customerCardSince | dttm | O | Datum, seit dem eine Kundenkarte existiert im Format YYYY-MM-DD |
customerCardClassification | ans..32 | O | Gibt den Level der Kundenkarte an, z.B. „Gold Member“ |
profileTrackingId | ans..64 | O | Eindeutige TrackingID |
ipAddress | ans..15 | O | IP Adresse des Kunden |
numberOfTransactions | n..5 | O | Anzahl der erfolgreichen Transaktionen, die der Kunden bereits getätigt hat |
customerIndividualScore | n..5 | O | Vom Händler zur Verfügung gestellter individueller Score für den Kunden |
Beispiel CustomerRisk als JSON-String
{ "existingCustomer" : true, "verifiedCustomerIdentification" : "true", "marketingOptIn" : "false", "customerSince" : "2015-11-20", "customerClassification" : "Classification", "acquisitionChannel" : “SearchEngine”, "hasCustomerCard" : true, "customerCardSince" : "2016-01-23", "customerCardClassification" : "Gold Member", "profileTrackingId" : "TrackingID123456", "ipAddress" : "201.18.14.2", "numberOfTransactions" : 27, "customerIndividualScore" : 98 } |
Order
Hier werden die Informationen zu einer Bestellung definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
totalGrossAmount | ans..16 | M | Bruttobetrag der Bestellung. Muss gleich dem Wert aller Artikel aus items (grossUnitPrice * quantity) sein. Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
currency | Enum | O | Währung: Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“ |
items | Array | O | Array von OrderItems (siehe JSON-Objekte / OrderItem) |
totalNetAmount | ans..16 | M | Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im AfterPay-Portal gesehen werden. Beschränkt auf 100-1280px. |
googleAnalyticsUserId | ans..64 | O | Google Analytics UserID |
googleAnalyticsClientId | ans..64 | O | Google Analytics ClientID |
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
OrderItem
Hier werden die Informationen zu einem Artikel definiert.
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
productId | ans..64 | M | Artikelnummer | ||||||||
description | ans..128 | M | Artikelbeschreibung | ||||||||
quantity | n..8 | M | Artikelanzahl. Dezimalwerte, wenn mit | ||||||||
grossUnitPrice | ans..16 | M | Bruttopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
groupId | ans..64 | O | GruppenID | ||||||||
netUnitPrice | ans..16 | M | Nettopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
unitCode | ans..16 | O | Einheit (z.B. Stück, Liter, Kilogramm, etc.) | ||||||||
vatCategory | enum | O | Umsatzsteuerkategorie Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory" | ||||||||
vatPercent | n..2 | M | Umsatzsteuer in Prozent | ||||||||
vatAmount | ans..16 | M | Umsatzsteuer als Betrag pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im AfterPay-Portal gesehen werden. Beschränkt auf 100-1280px. | ||||||||
googleProductCategoryId | n..16 | O | Google Product Category ID | ||||||||
googleProductCat egory | ans..64 | O | Google Product Category | ||||||||
merchantProductType | ans..64 | O | Kategorisierung des Händlers ergänzend zur Google-Klassifizierung | ||||||||
lineNumber | n.3 | O | Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren | ||||||||
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
productUrl | ans..256 | O | URL zum Artikel | ||||||||
marketPlaceSellerId | ans..64 | O | ID eines bestimmten Marktplatzes |
Beispiel Order als JSON-String
{ "totalGrossAmount" : 12.40, "totalNetAmount" : 10.43, "currency" : "EUR", "items" : [{ "productId" : "1", "description" : "Tablet Black", "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "quantity" : 2.0, "vatAmount" : 0.65, "vatPercent" : 19.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "quantity" : 1.0, "vatAmount" : 0.67, "vatPercent" : 19.0 } ] } |
AllowedPayMethods
Hier werden die Informationen zu den erlaubten Zahlungsarten in einem Array definiert.
PaymentMethod
Hier werden die Informationen zu einem Artikel definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
type | enum | O | Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice" |
account | AccountProduct | O | Account-Informationen (siehe JSON-Objekte / AccountProduct) |
directDebit | DirectDebitInfo | O | Direct-Debit-Informationen (siehe JSON-Objekte / DirectDebitInfo) |
campaigns | Array | O | Array von Kampagnen-Informationen (siehe JSON-Objekte / CampaignInfo) |
Installment | InstallmentInfo | O | Ratenkauf-Informationen (siehe JSON-Objekte / InstallmentInfo) |
AccountProduct
Hier werden die Informationen zu einem AccountProduct definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
profileNo | n..32 | M | Account-Profilnummer |
DirectDebitInfo
Hier werden die Informationen zu DirectDebitInfo definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Available | Bool | O | Gibt an, ob DirectDebit verfügbar ist. |
CampaignInfo
Hier werden die Informationen zu CampaignInfo definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
campaignNo | n..32 | O | Kampagnennummer |
description | ans..128 | O | Kampagnenbeschreibung |
InstallmentInfo
Hier werden die Informationen zu InstallmentInfo definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
basketAmount | enum | O | Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice" Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
numberOfInstallments | n..2 | O | Anzahl der Raten |
installmentAmount | ans..16 | O | Ratenbetrag für jeden Monat Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
firstInstallmentAmount | ans..16 | O | Erster Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
lastInstallmentAmount | ans..16 | O | Letzter Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
interestRate | ans..16 | O | Zinssatz |
effectiveInterestRate | ans..16 | O | Effektiver Zinssatz |
effectiveAnnualPercentageRate | ans..16 | O | Effektiver jährlicher Prozentsatz |
totalInterestAmount | ans..16 | O | Gesamtzinssatz Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
startupFee | ans..16 | O | Anfangsgebühr Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
monthlyFee | ans..16 | O | Monatliche Gebühr Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
totalAmount | ans..16 | O | Gesamtbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
installmentProfileNumber | ans..16 | O | Raten Profilnummer |
readMore | ans..128 | O | Weitere Informationen zum Ratenprozess |
Beispiel AllowedPaymentMethods als JSON-String
{ "paymentMethods" : [{ "type" : "Invoice" }, { "type" : "Invoice", "directDebit" : { "available" : true } } ] } |
Address
Hier werden die Informationen zu ggfls. korrigierten Rechnungsdaten in einem Array definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
countryCode | enum | O | Ländercode Mögliche Werte: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“ |
postalCode | ans..10 | O | Postleitzahl |
postalPlace | ans..100 | O | Ort |
Street | ans..100 | O | Straße oder Packstation |
streetNumber | ans..10 | O | Haus- oder Packstationsnummer |
streetNumberAdditional | ans..10 | O | Straßennummernzusatz |
careOf | ans..50 | O | Verantwortlicher für den Versand der Sendung |
Beispiel Address als JSON-String
{ [{ "countryCode" : "DE", "postalCode" : "10405", "street" : "Prenzlauer Allee", "streetNumber" : 20 "streetNumberAdditional" : "3. Stock", "postalPlace" : "Berlin", "addressType" : null, "careOf" : null } ] } |
OrderSummary
Hier werden die Informationen zu einer OrderSummary definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
totalGrossAmount | ans..16 | O | Bruttobetrag der Bestellung. Muss gleich dem Wert aller Artikel aus items (grossUnitPrice * quantity) sein. Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
currency | Enum | O | Währung. Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“ |
items | Array | O | Array von OrderItems (siehe JSON-Objekte / OrderItem) |
totalNetAmount | ans..16 | O | Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im AfterPay-Portal gesehen werden. Beschränkt auf 100-1280px. |
googleAnalyticsUserId | ans..64 | O | Google Analytics UserID |
googleAnalyticsClientId | ans..64 | O | Google Analytics ClientID |
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. |
Beispiel OrderSummary als JSON-String
{ "totalGrossAmount" : 8.30, "currency" : "EUR", "items" : [{ "productId" : "1", "description" : "Tablet Black", "grossUnitPrice" : 4.10, "quantity" : 1.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "grossUnitPrice" : 4.20, "quantity" : 1.0 } ] } |
ShippingData
Hier werden die Informationen zum Versand in einem Array definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
shippingDetails | Array | M | Array von Versandinformationen (siehe JSON-Objekte / ShippingDetails) |
ShippingDetails
Hier werden die Informationen zu ShippingDetails definiert.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
type | enum | M | Versandtyp: Mögliche Werte sind „Shipment“, „Return“ |
shippingCompany | ans..64 | M | Versandunternehmen |
trackingId | ans..64 | M | Eindeutige TrackingID |
Beispiel ShippingData als JSON-String
{ "shippingDetails" : [{ "type" : "Shipment", "shippingCompany" : "DHL", "trackingId" : "234324234" }, { "type" : "Shipment", "shippingCompany" : "Hermes", "trackingId" : "687654" } ] } |
RefundOrder
Hier werden die Informationen zu den Artikeln definiert, die gutzuschreiben sind.
Parameter | Format | CND | Beschreibung |
orderItems | Array | M | Array von Artikeln zum Gutschreiben (siehe JSON-Objekte / RefundOrderItem) |
RefundOrderItem
Hier werden die Informationen zu einem RefundOrderItem definiert.
Parameter | Format | CND | Beschreibung | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
refundType | enum | M | Gutschriftstyp: Mögliche Werte sind „Refund“, „Return“ | ||||||||
productId | ans..64 | M | Artikelnummer | ||||||||
description | ans..128 | M | Artikelbeschreibung | ||||||||
quantity | n..8 | M | Artikelanzahl. Dezimalwerte, wenn mit | ||||||||
grossUnitPrice | ans..16 | M | Bruttopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
groupId | ans..64 | O | GruppenID | ||||||||
netUnitPrice | ans..16 | M | Nettopreis pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
unitCode | ans..16 | O | Einheit (z.B. Stück, Liter, Kilogramm, etc.) | ||||||||
vatCategory | enum | O | Umsatzsteuerkategorie Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory" | ||||||||
vatPercent | n..2 | M | Umsatzsteuer in Prozent | ||||||||
vatAmount | ans..16 | M | Umsatzsteuer als Betrag pro Artikel Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
imageUrl | ans..256 | O | URL für ein Bild zur Bestellung. Dieses Bild kann auf der Rechnung oder neben der Ratenzahlung im AfterPay-Portal gesehen werden. Beschränkt auf 100-1280px. | ||||||||
googleProductCategoryId | n..16 | O | Google Product Category ID | ||||||||
googleProductCat egory | ans..64 | O | Google Product Category | ||||||||
merchantProductType | ans..64 | O | Kategorisierung des Händlers ergänzend zur Google-Klassifizierung | ||||||||
lineNumber | n.3 | O | Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren | ||||||||
discountAmount | ans..16 | O | Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind. | ||||||||
productUrl | ans..256 | O | URL zum Artikel | ||||||||
marketPlaceSellerId | ans..64 | O | ID eines bestimmten Marktplatzes |
Beispiel RefundOrder als JSON-String
[ { "refundType" : "Return", "productId" : "1", "description" : "Tablet Black", "quantity" : 1.0, "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "vatPercent" : 19.0, "vatAmount" : 0.65 } , { "refundType" : "Return", "productId" : "2", "description" : "MusicPlayer Black", "quantity" : 1.0, "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "vatPercent" : 19.0, "vatAmount" : 0.67 } ] |