About Afterpay

General information about Afterpay

Page properties

Logo

Info

Excerpt
AfterPay offers purchase on account after delivery. Buyers can pay for articles by invoice, direct debit or installment. There is no risk of fraud or payment default for the merchant. After a credit check, AfterPay assumes the entire end customer payment default risk for each transaction.

Type

Payments by Invoice and Installments

Further information can be found on the website of AfterPay (https://www.afterpay.de/).

Process Flow Chart

Multiexcerpt

MultiExcerptName	ProcessFlow

draw.io Diagram

border	true
diagramName	Afterpay
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1109

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

Query about available payment types (two-stage authorisation)

AfterPay differentiates between one-stage and two-stage authorisation. One-stage authorisation is designed for merchants who only use the normal method of payment by invoice in their checkout. Two-stage authorisation permits, for a specific shopping basket, a query of the available payment types and a request for further information.

In order to process two-stage authorisation with AfterPay via server-to-server communication, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

afterpay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1617185054273_872795791
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647523762994_-666958180
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	MC	TransactionID which should be unique for each payment. The parameter is not required for EventToken="Return".	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	OC	Unique reference number. The parameter is not required for EventToken="Return".	Eindeutige Referenznummer
PayID	an32	C	ID assigned by Paygate for the payment in scope of which goods were returned. The parameter is required only for EventToken="Return".
InvoiceNr	ans..30	C	Invoice number that is displayed within AfterPay portal. An order can contain more than one invoice. The parameter is required only for EventToken="Return".	Rechnungsnummer, die im AfterPay-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten.

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key

Format

CND

Description

Beschreibung

EventToken

a..19

M

The two-stage process is triggered by the transfer of "PAYMENTMETHODS"

Value "Return" triggers return notification (merchant notifies Afterpay what a customer has returned some goods, and a payment from the customer should not be expected by Afterpay).

Der zweistufige Prozess wird durch die Übermittlung von "PAYMENTMETHODS" ausgelöst

AddrCountryCode

a2

M

Country code

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

Ländercode

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

Order

ans..1024

M

Order information as JSON string in Base64 format.

See JSON object: Order

For EventToken="Return", see JSON object RefundOrder

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: Order

Parameters for payments with AfterPay

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1617185481981_517112525
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647523888351_92052994
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Status
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

AllowedPayMethods

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects: AllowedPayMethods)

Erlaubte Zahlungsarten als JSON-String im Format Base64.

(siehe JSON-Objekte: AllowedPayMethods)

Result parameters for AfterPay

The second stage involves the transfer of the customer and order data as well as payment type and, if relevant, further information relating to the payment type.

The second stage is triggered by using the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

afterpay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647524352750_1931526606
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_step2_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647524352752_-82950462
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
PayType	a..19	M	Payment method: "Invoice" for Invoice "Account" for flexible payment plan "Installment" for payment by instalment "ConsolidatedInvoice" for consolidated invoice For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.	Zahlungsmethode: „Invoice“ für Rechnung „Account“ für flexibler Zahlungsplan „Installment“ für Ratenzahlungen „ConsolidatedInvoice“ für konsolidierte Rechnung Für Lastschrift muss der Parameter PayType auf "Invoice" gesetzt und Parameter IBAN angegeben werden.
bdCompanyOrPerson	a..7	M	Customer category: „Company“ „Person“ (default value)	Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert)
SocialSecurityNumber	ans..16	C	Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.	Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Sozialversicherungsnummer bei einer Person in Schweden. Registrierungsnummer im Falle eines Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft.
LegalForm	ans..50	O	Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson. Possible values: For Germany: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Austria: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Switzerland: AG, eG, e.V.	Rechtsform des Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. Mögliche Werte: Für Deutschland: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für Österreich: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für die Schweiz: AG, eG, e.V.
AddrCountryCode	a2	O	Country code: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”	Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
AddrZip	ans..10	M	Postcode	Postleitzahl
AddrStreet	ans..80	M	Street name or packstation	Straße oder Packstation
AddrStreetNr	a..50	O	Street number or packstation number	Haus- oder Packstationsnummer
AddrStreetNr2	ans..10	O	Street number addition	Hausnummernzusatz
AddrCity	ans..100	M	City	Ort
careOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."	per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V."
FirstName	ans..50	M	First name	Vorname
LastName	ans..50	M	Last name	Nachname
CustomerID	ans..20	O	Unique customer number	Eindeutige Kundennummer
Salutation	a..4	O	Salutation: „Mr“ „Mrs“ „Miss“	Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein
bdEmail	ans..100	M	E-mail address	E-Mail-Adresse
bdPhone	ns..20	O	Telephone number	Telefonnummer
bdMobileNo	ns..20	O	Mobile number	Handynummer
DateOfBirth	an10	M	Date of birth in the format YYYY-MM-DD. Not applicable to companies.	Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend.
bdCompany	ans..50	C	Purchasing company name. Required if bdCompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.	Name des kaufenden Unternehmens. Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.
VatID	ans..50	C	VAT registration number, the unique number that identifies a business. The field is mandatory for processing B2B transactions for Germany.	Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert. Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch.
CustomerRisk	ans..1024	M	Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk) Merchants can conduct external risk checks and send this information to AfterPay.	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.
Language	a2	O	Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted	Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig
CompanyOrPerson	a..7	C	Customer category for delivery address: „Company“ „Person“ (default value) Requred if any of sd-fields (refer below) is provided.	Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird.
sdCountryCode	a2	O	Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”	Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip	ans..10	O	Postcode in the delivery address	Postleitzahl der Lieferadresse
sdStreet	ans..80	O	Street name or packstation of the delivery address	Straße oder Packstation der Lieferadresse
sdStreetNr	a..50	O	Street number or packstation number of the delivery address	Haus- oder Packstationsnummer der Lieferadresse
sdStreetNr2	ans..10	O	Street number addition of the delivery address	Straßennummernzusatz der Lieferadresse
sdCity	ans..100	O	Town/city of the delivery address	Ort der Lieferadresse
sdcareOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."	per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V."
ShippingMethod	ans..50	O	Address type. Possible values: "Standard" (default value), "PickUpPoint", "InStore"	Adressentyp. Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore"
sdFirstName	ans..50	O	First name in the delivery address	Vorname der Lieferadresse
sdLastName	ans..50	O	Last name in the delivery address	Nachname der Lieferadresse
sdSalutation	a..4	O	Salutation in the delivery address „Mr“ „Mrs“ „Miss“ Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“	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“
Email	ans..100	O	E-mail address of the delivery address	E-Mail-Adresse der Lieferadresse
Phone	ns..50	O	Phone number in the delivery address	Telefonnummer der Lieferadresse
MobileNo	ns..50	O	Mobile number of the delivery address	Handynummer der Lieferadresse
sdCompany	ans..50	C	Delivery company name. Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.	Name des kaufenden Unternehmens. Erforderlich, wenn CompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.
BIC	ans..11	O	Bank Identifier Code (valid for AddrCountryCode = “DE”)	Bank Identifier Code (gültig bei AddrCountryCode = “DE”)
IBAN	ans..34	O	International Bank Account Number (valid for AddrCountryCode = “DE”)	International Bank Account Number (gültig bei AddrCountryCode = “DE”)
ProductNr	n..8	C	Profile number Obligatory for PayType = "Account" or "Installment"	Profilnummer Pflicht bei PayType = "Account" oder "Installment"
InvoiceDate	an10	O	Date of invoice in the format YYYY-MM-DD. Only for PayType = "ConsolidatedInvoice"	Rechnungsdatum im Format JJJJ-MM-TT. Nur bei PayType = "ConsolidatedInvoice"

Parameters for AfterPay

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647586876798_-1935036698
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_step2_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647586876800_1691782573
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer
Status	a..50	M	AUTHORIZE_REQUEST or FAILED	AUTHORIZE_REQUEST oder FAILED

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

BillingAddress

ans..1024

O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects: Address)

Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte / Address)

ShippingAddress

ans..1024

O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects: Address)

Gegebenenfalls korrigierte Lieferadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte: Address)

Result parameters for AfterPay

Calling the interface for one-stage authorisation

To process one-stage authorisation with AfterPay, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

afterpay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647588181025_-1875616216
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_onestage_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647588181027_2000475579
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
PayType	a..19	M	Payment method: "Invoice" for Invoice For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.	Zahlungsmethode: „Invoice“ für Rechnung Für Lastschrift muss der Parameter PayType auf "Invoice" gesetzt und Parameter IBAN angegeben werden.
BIC	ans..11	O	Bank Identifier Code (valid for AddrCountryCode = “DE”)	Bank Identifier Code (gültig bei AddrCountryCode = “DE”)
IBAN	ans..34	O	International Bank Account Number (valid for AddrCountryCode = “DE”)	International Bank Account Number (gültig bei AddrCountryCode = “DE”)
bdCompanyOrPerson	a..7	O	Customer category: „Company“ „Person“ (default value)	Kundenkategorie: „Company“ für Unternehmen „Person“ für Personen (Standardwert)
SocialSecurityNumber	ans..16	C	Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.	Pflicht: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Sozialversicherungsnummer bei einer Person in Schweden. Registrierungsnummer im Falle eines Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft.
LegalForm	ans..50	O	Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson. Possible values: For Germany: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Austria: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Switzerland: AG, eG, e.V.	Rechtsform des Unternehmens. Dieser Parameter ist mit dem Parameter bdCompanyOrPerson verknüpft. Mögliche Werte: Für Deutschland: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für Österreich: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG Für die Schweiz: AG, eG, e.V.
AddrCountryCode	a2	O	Country code: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”	Ländercode: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
AddrZip	ans..10	M	Postcode	Postleitzahl
AddrStreet	ans..80	M	Street name or packstation	Straße oder Packstation
AddrStreetNr	a..50	O	Street number or packstation number	Haus- oder Packstationsnummer
AddrStreetNr2	ans..10	O	Street number addition	Hausnummernzusatz
AddrCity	ans..100	M	City	Ort
careOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."	per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V."
FirstName	ans..50	M	First name	Vorname
LastName	ans..50	M	Last name	Nachname
CustomerID	ans..20	O	Unique customer number	Eindeutige Kundennummer
Salutation	a..4	O	Salutation: „Mr“ „Mrs“ „Miss“	Anrede: „Mr“ für Herr „Mrs“ für Frau „Miss“ für Fräulein
bdEmail	ans..100	M	E-mail address	E-Mail-Adresse
bdPhone	ns..20	O	Telephone number	Telefonnummer
bdMobileNo	ns..20	O	Mobile number	Handynummer
DateOfBirth	an10	M	Date of birth in the format YYYY-MM-DD. Not applicable to companies.	Geburtsdatum im Format JJJJ-MM-TT. Für Firmen nicht zutreffend.
bdCompany	ans..50	C	Purchasing company name. Required if bdCompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.	Name des kaufenden Unternehmens. Erforderlich, wenn bdCompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.
VatID	ans..50	C	VAT registration number, the unique number that identifies a business. The field is mandatory for processing B2B transactions for Germany.	Umsatzsteuer-Identifikationsnummer, die eindeutige Nummer, die ein Unternehmen identifiziert. Das Feld ist für die Abwicklung von B2B-Transaktionen für Deutschland obligatorisch.
CustomerRisk	ans..1024	M	Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk) Merchants can conduct external risk checks and send this information to AfterPay.	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.
Language	a2	O	Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted	Sprache: „NO“, „SE“, „FI“, „DK”, “EN”, “DE”, “NL”, “FR” zulässig
CompanyOrPerson	a..7	C	Customer category for delivery address: „Company“ „Person“ (default value) Requred if any of sd-fields (refer below) is provided.	Kundenkategorie der Lieferadresse: „Company“ für Unternehmen „Person“ für Personen (Standardwert) Erforderlich, falls eines der sd-Felder (siehe unten) angegeben wird.
sdCountryCode	a2	O	Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”	Ländercode der Lieferadresse: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip	ans..10	O	Postcode in the delivery address	Postleitzahl der Lieferadresse
sdStreet	ans..80	O	Street name or packstation of the delivery address	Straße oder Packstation der Lieferadresse
sdStreetNr	a..50	O	Street number or packstation number of the delivery address	Haus- oder Packstationsnummer der Lieferadresse
sdStreetNr2	ans..10	O	Street number addition of the delivery address	Straßennummernzusatz der Lieferadresse
sdCity	ans..100	O	Town/city of the delivery address	Ort der Lieferadresse
sdcareOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."	per Adresse. Vermittler, der für die Beförderung einer Postsendung vom Postsystem zum endgültigen Empfänger verantwortlich ist. Zum Beispiel Jane c/o John (“Jane an der Adresse von John”). Dieses Feld muss auch für Firmen-, Behörden- und Organisationsnamen verwendet werden – z. B. "Sportverein Blau-Weiß e.V."
ShippingMethod	ans..50	O	Address type. Possible values: "Standard" (default value), "PickUpPoint", "InStore"	Adressentyp. Mögliche Werte: "Standard" (Standardwert), "PickUpPoint", "InStore"
sdFirstName	ans..50	O	First name in the delivery address	Vorname der Lieferadresse
sdLastName	ans..50	O	Last name in the delivery address	Nachname der Lieferadresse
sdSalutation	a..4	O	Salutation in the delivery address „Mr“ „Mrs“ „Miss“ Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“	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“
Email	ans..100	O	E-mail address of the delivery address	E-Mail-Adresse der Lieferadresse
Phone	ns..50	O	Phone number in the delivery address	Telefonnummer der Lieferadresse
MobileNo	ns..50	O	Mobile number of the delivery address	Handynummer der Lieferadresse
sdCompany	ans..50	C	Delivery company name. Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.	Name des kaufenden Unternehmens. Erforderlich, wenn CompanyOrPerson gleich 'Company' ist. Alles ab 50 Zeichen wird abgeschnitten.
Order	ans..1024	M	Order information as JSON string in Base64 format. See JSON object: Order	Bestellinformationen als JSON-String im Format Base64. Siehe JSON-Objekt: Order

Parameters for payments with AfterPay

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647589838516_1981951386
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	afterpay_onestage_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647589838518_485667623
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

BillingAddress

ans..1024

O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects: Address)

Gegebenenfalls korrigierte Rechnungsadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte / Address)

ShippingAddress

ans..1024

O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects: Address)

Gegebenenfalls korrigierte Lieferadresse als JSON-String im Base64-Format.

(siehe JSON-Objekte: Address)

Result parameters for AfterPay

Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture for AfterPay via a Server-to-Server connection, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

capture.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647593397118_-2047699646
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	capture_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647593397120_-1667249931
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Capture
page	PayID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices, merchant’s comment etc.	Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

Order

ans..1024

C

Mandatory for partial capture or if order information have changed with the same total amount.

Order information as JSON string in Base64 format.

See JSON object: Order

Pflicht bei Teilbuchung oder wenn sich die Bestellinformationen bei gleichem Gesamtbetrag geändert haben.

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: Order

InvoiceNr

ans..30

O

Is considered only if Order is also transferred.

Invoice number that is displayed within AfterPay portal. An order can contain more than one invoice.

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

Is considered only if Order is also transferred.

Shipping information as JSON string in Base64 format.

(see JSON objects: ShippingData)

Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird.

Versandinformationen als JSON-String im Base64-Format.

(siehe JSON-Objekte: ShippingData)

Parameters for AfterPay captures

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647594453734_-85472397
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	capture_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647594453736_1515537751
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Unique reference number	Eindeutige Referenznummer
Status	a..50	M	OK, CAPTURE_REQUEST or FAILED	OK, CAPTURE_REQUEST oder FAILED

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

InvoiceNumber

ans..30

O

Booking number: generated by merchant or, if not available, by AfterPay. Is necessary for partial credits.

Buchungsnummer: wird vom Händler erzeugt oder falls nicht verfügbar von AfterPay. Sie ist für Teilgutschriften erforderlich.

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

Result parameters for AfterPay captures

Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

credit.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647596357999_-648319399
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647596358000_-1457779191
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Credit
page	PayID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Reference number (e.g. invoice number) which must be unique for each return shipment	Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices, merchant’s comment etc.	Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Key

Format

CND

Description

Beschreibung

Order

ans..1024

C

Mandatory for partial credits

Order information as JSON string in Base64 format.

See JSON object: RefundOrder

Pflicht bei Teilgutschriften

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: RefundOrder

InvoiceNr

ans..30

C

Is considered only if Order is also transferred, but then it is mandatory.

Invoice number that is displayed within AfterPay portal. An order can contain more than one invoice.

Wird nur berücksichtigt, wenn Order ebenfalls gesendet wird, ist dann allerdings Pflicht.

Rechnungsnummer, die im AfterPay-Portal angezeigt wird. Eine Bestellung kann mehrere Rechnungen enthalten.

RefundType

enum

O

Type or credit: Possible values are "Refund“ and "Return"

Is necessary only for a full credit.

Art der Gutschrift: Mögliche Werte sind „Refund“ und „Return“

Wird nur bei einer kompletten Gutschrift benötigt.

Parameters for credits of AfterPay payments

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647597055640_411505718
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647597055643_2135591708
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Merchant’s unique reference number	Eindeutige Referenznummer des Händlers

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

Result parameters for credits of AfterPay payments

Reverse

Reversals are possible via a Server-to-Server connection. In order to reverse an AfterPay transaction, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

reverse.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647598139087_-191413738
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	reverse_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647598139089_1835371346
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Reverse
page	PayID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Key

Format

CND

Description

Beschreibung

Order

ans..1024

C

Mandatory for partial reversals

Order information as JSON string in Base64 format.

See JSON object: OrderSummary

Pflicht bei Teilstornierungen

Bestellinformationen als JSON-String im Format Base64.

Siehe JSON-Objekt: OrderSummary

Parameters for reversals of AfterPay payments

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647598773556_-1792741018
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	reverse_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647598773557_-238560856
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von AfterPay, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

Result parameters for reversals of AfterPay payments

Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing an AfterPay payment and information can be found within the response file about the payment status.

Notice: Please note that partial captures, partial credits and partial reversals for AfterPay are not possible with batch.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647599002447_169154101
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_versions

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647599002448_217413410
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Action	Version	Description	Beschreibung
Capture	1.0 / 2.0	Standard version without return of parameter Code	Standardversion ohne Rückgabe von Parameter Code
	1.x / 2.x	with RefNr (valid for all versions other than 1.0)	mit RefNr (gilt für alle Versionen außer 1.0)
Credit	1.0 / 2.0	Standard version without return of parameter Code	Standardversion ohne Rückgabe von Parameter Code
	1.x / 2.x	with RefNr (valid for all versions other than 1.0)	mit RefNr (gilt für alle Versionen außer 1.0)
Reverse	1.0 / 2.0	Standard version without return of parameter Code	Standardversion ohne Rückgabe von Parameter Code
	1.x / 2.x	with RefNr (valid for all versions other than 1.0)	mit RefNr (gilt für alle Versionen außer 1.0)

Description of the possible batch versions

The structure for an AfterPay payment in a Batch file to be submitted is as follows:

Multiexcerpt

MultiExcerptName	batch_structure
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

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>

Example for Master MID function:

Multiexcerpt

MultiExcerptName	batch_MasterMid
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

The following table describes the individual fields and values used within the data set (record) in the batch file:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647599449322_1972111528
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647599449323_1997138816
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, AFTERPAY for AfterPay

HEAD für Header, FOOT für Footer, AFTERPAY für AfterPay

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

Table Excerpt Include

name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..18	M	TransactionID which should be unique for each payment	TransaktionsID, die für jede Zahlung eindeutig sein muss
RefNr	ns..30	O	Merchant’s unique reference number	Eindeutige Referenznummer des Händlers

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

Description of fields within the record for Batch files

The record area within the response file for Batch transactions looks as follows:

Multiexcerpt

MultiExcerptName	batch_structure_response
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	xml

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>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647600341174_-1815387064
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647600341175_1364607256
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
Action	a..20	M	The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation)	Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno)

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Description of result parameters within the record for Batch files

JSON Objects

The JavaScript Object Notation, JSON for short, is a compact data format in an easy-to-read text format for the purpose of exchanging data between applications. JSON does not depend on the programming language. Parsers exist in practically all widely used languages. You can find more information about JSON via this link:

https://wiki.selfhtml.org/wiki/JavaScript/JSON

The next section describes JSON objects which are required for requests or returned in the response.

Notice: The JSON string can include special characters and so must also be Base64 encoded. Transfer problems may otherwise occur.

CustomerRisk

Risk-relevant data about the customer. Merchants can conduct external risk checks and send this information to AfterPay.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647608355028_-1655237953
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_CustomerRisk

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647608355030_-23039290
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
existingCustomer	bool	O	Indicates whether the customer is an existing customer of the merchant	Gibt an, ob der Kunde ein für den Händler bereits existierender Kunde ist
verifiedCustomerIdentification	bool	O	Indicates whether the customer has been verified	Gibt an, ob der Kunde verifiziert wurde
marketingOptIn	bool	O	Indicates whether marketing material is requested	Gibt an, ob Marketing-Material erwünscht ist
customerSince	dttm	O	Date in format YYYY-MM-DD since which the customer has existed	Datum, seit dem der Kunde existiert im Format JJJJ-MM-TT
customerClassification	ans..32	O	Customer classification	Kundenklassifizierung
acquisitionChannel	enum	O	Indicates the channel via which the merchant is reached. Possible values: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”	Gibt den genutzten Kanal an, um auf die Händlerseite zu gelangen. Mögliche Werte: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”
hasCustomerCard	bool	O	Indicates whether the customer has a loyalty card	Gibt an, ob der Kunde eine Kundenkarte besitzt
customerCardSince	dttm	O	Date in format YYYY-MM-DD since which the loyalty card has existed	Datum, seit dem eine Kundenkarte existiert im Format JJJJ-MM-TT
customerCardClassification	ans..32	O	Indicates the loyalty card level, e.g. "Gold Member"	Gibt den Level der Kundenkarte an, z.B. „Gold Member“
profileTrackingId	ans..64	O	Unique TrackingID	Eindeutige TrackingID
ipAddress	ans..15	M	Customer´s IP address	IP-Adresse des Kunden
numberOfTransactions	n..5	O	Number of successful transactions already completed by the customer	Anzahl der erfolgreichen Transaktionen, die der Kunden bereits getätigt hat
customerIndividualScore	n..5	O	Individual score for the customer supplied by the merchant	Vom Händler zur Verfügung gestellter individueller Score für den Kunden
userAgent	ans..32	O	UserAgent of this specific consumer	UserAgent dieses bestimmten Kunden
amountOfTransactions	n..5	O	Amount of paid orders last 12 months	Betrag der bezahlten Bestellungen in den letzten 12 Monaten
otherPaymentMethods	bool	O	Other payment method than MI in wallet	Andere Zahlungsmethode außer MI im Wallet

Example CustomerRisk as JSON string

Multiexcerpt

MultiExcerptName	JSON_CustomerRisk_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
      "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,
      "userAgent" : "",
      "amountOfTransactions" : 1,
      "otherPaymentMethods" : true
}

Order

The order information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647608956507_-397754313
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_Order

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647608956508_-666230810
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
totalGrossAmount	ans..16	M	Gross order amount. Must equal the value of all items (grossUnitPrice * quantity). Please note, that values has to be specified with “.” as decimal separator.	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	Currency: Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“	Währung: Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“
risk	ans..1024	O	Order risk-relevant data as JSON string in Base64 format (see JSON object: OrderRisk)	Risikorelevante Daten der Bestellung als JSON-String im Base64 (siehe JSON-Objekt: OrderRisk)
items	Array	M	Array of OrderItems (see JSON object: OrderItem)	Array von OrderItems (siehe JSON-Objekt: OrderItem)
totalNetAmount	ans..16	M	Net order amount Please note, that values has to be specified with “.” as decimal separator.	Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.	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	Google Analytics UserID
googleAnalyticsClientId	ans..64	O	Google Analytics ClientID	Google Analytics ClientID
discountAmount	ans..16	O	Discount amount (only for statistical purposes) Please note, that values has to be specified with “.” as decimal separator.	Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

OrderRisk

The order risk information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647609616923_1873047542
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_OrderRisk

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647609616924_381932375
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key

Format

CND

Description

Beschreibung

channelType

ans..64

O

Order channel type. Possible values:

"Internet", "Catalog", "CallCenter", "Stationary", "Other".

Kanal der Bestellung. Mögliche Werte:

"Internet", "Catalog", "CallCenter", "Stationary", "Other".

deliveryType

ans..64

O

Order delivery type. Possible values:

"Normal", "Express".

Typ der Lieferung. Mögliche Werte:

"Normal", "Express".

ticketDeliveryMethod

ans..64

O

Name of the tickets' method. Possible values:

"NotSet", "PickUp", "Email", "Post", "Phone".

Name der Ticket-Methode. Mögliche Werte:

"NotSet", "PickUp", "Email", "Post", "Phone".

OrderItem

The order information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647613765392_-791461220
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_OrderItem

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647613765394_-1188937820
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key

Format

CND

Description

Beschreibung

productId

ans..64

M

Article number

Artikelnummer

description

ans..128

M

Article description

Artikelbeschreibung

type

ans..64

O

Order item type. Possible values:

"PhysicalArticle", "DigitalArticle", "GiftCard", "Discount", "ShippingFee", "Surcharge", "Info"

Typ des Artikels. Mögliche Werte:

"PhysicalArticle", "DigitalArticle", "GiftCard", "Discount", "ShippingFee", "Surcharge", "Info"

quantity

n..8

M

Article quantity

Decimal values, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

and AfterPay.

Artikelanzahl.

Dezimalwerte, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Partner-Name
PageWithExcerpt	DE:Wording

und AfterPay abgesprochen.

grossUnitPrice

ans..16

M

Gross price per article

Please note, that values has to be specified with “.” as decimal separator.

Bruttopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

grouId

ans..64

O

GroupID

GruppenID

netUnitPrice

ans..16

M

Net price per article

Please note, that values has to be specified with “.” as decimal separator.

Nettopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

unitCode

ans..16

O

Unit (e.g. pieces, litres, kilograms, etc.)

Einheit (z.B. Stück, Liter, Kilogramm, etc.)

vatCategory

enum

O

VAT category

Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

Umsatzsteuerkategorie

Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

vatPercent

n..2

M

VAT in percent

Umsatzsteuer in Prozent

vatAmount

ans..16

M

VAT as amount per item

Please note, that values has to be specified with “.” as decimal separator.

Umsatzsteuer als Betrag pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

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

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

Kategorisierung des Händlers ergänzend zur Google-Klassifizierung

lineNumber

n.3

O

The merchant can specify a line number for each article for sorting purposes

Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

Rabattbetrag (nur für statistische Zwecke)

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

productUrl

ans..256

O

Article URL

URL zum Artikel

marketPlaceSellerId

ans..64

O

ID of a specific market place

ID eines bestimmten Marktplatzes

Example of Order as JSON string

Multiexcerpt

MultiExcerptName	JSON_Order_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
       "totalGrossAmount" : 12.40,
       "totalNetAmount" : 10.43,
       "currency" : "EUR",
       "risk" : {
                    "channelType" : "Catalog",
                    "deliveryType" : "Normal",
                    "ticketDeliveryMethod" : "NotSet"                    
             },
       "items" : [{
                    "productId" : "1",
                    "description" : "Tablet Black",
                    "type" : "PhysicalArticle",
                    "grossUnitPrice" : 4.10,
                    "netUnitPrice" : 3.45,
                    "quantity" : 2.0,
                    "vatAmount" : 0.65,
                    "vatPercent" : 19.0                             
             }, {
                    "productId" : "2",
                    "description" : "MusicPlayer Black",
                    "type" : "PhysicalArticle",
                    "grossUnitPrice" : 4.20,
                    "netUnitPrice" : 3.53,
                    "quantity" : 1.0,
                    "vatAmount" : 0.67,
                    "vatPercent" : 19.0
             }
       ]
}

AllowedPayMethods

The information about the allowed payment types is defined here in an array.

PaymentMethod

The article information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647616278674_-791461220
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_PaymentMethod

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647616278675_-1188937820
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
type	ans..32	O	Available payment method Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"	Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice"
account	AccountProduct	O	Account information (see JSON object: AccountProduct)	Account-Informationen (siehe JSON-Objekt: AccountProduct)
directDebit	DirectDebitInfo	O	Direct-Debit information (see JSON object: DirectDebitInfo)	Direct-Debit-Informationen (siehe JSON-Objekt: DirectDebitInfo)
campaigns	Array	O	Array of campaign information (see JSON object: CampaignInfo)	Array von Kampagnen-Informationen (siehe JSON-Objekt: CampaignInfo)
Installment	InstallmentInfo	O	Instalment payment information (see JSON object: InstallmentInfo)	Ratenkauf-Informationen (siehe JSON-Objekt: InstallmentInfo)

AccountProduct

The AccountProduct information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647616752612_1465935352
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_AccountProduct

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647616752614_-1955383577
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
profileNo	n..32	M	Account profile number	Account-Profilnummer

DirectDebitInfo

The DirectDebitInfo information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647616877584_858999412
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_DirectDebitInfo

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647616877585_850087941
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
Available	bool	O	Indicates whether DirectDebit is available	Gibt an, ob DirectDebit verfügbar ist

CampaignInfo

The CampaignInfo information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647618035235_445697064
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_CampaignInfo

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647618035236_430360673
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
campaignNo	n..32	O	Campaign number	Kampagnennummer
description	ans..128	O	Campaign description	Kampagnenbeschreibung

InstallmentInfo

The InstallmentInfo information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647618234100_857324947
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_InstallmentInfo

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647618234102_-1370074724
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
basketAmount	enum	O	Available payment method Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice" Please note, that values has to be specified with “.” as decimal separator.	Verfügbare Zahlungsart Mögliche Werte: "Invoice", "Account", "Installment", "Consolidatedinvoice" Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
numberOfInstallments	n..2	O	Number of installments	Anzahl der Raten
installmentAmount	ans..16	O	Installment amount for each month Please note, that values has to be specified with “.” as decimal separator.	Ratenbetrag für jeden Monat Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
firstInstallmentAmount	ans..16	O	First installment amount Please note, that values has to be specified with “.” as decimal separator.	Erster Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
lastInstallmentAmount	ans..16	O	Final installment amount Please note, that values has to be specified with “.” as decimal separator.	Letzter Ratenbetrag Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
interestRate	ans..16	O	Interest rate	Zinssatz
effectiveInterestRate	ans..16	O	Effective interest rate	Effektiver Zinssatz
effectiveAnnualPercentageRate	ans..16	O	Effective annual percentage	Effektiver jährlicher Prozentsatz
totalInterestAmount	ans..16	O	Total interest rate Please note, that values has to be specified with “.” as decimal separator.	Gesamtzinssatz Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
startupFee	ans..16	O	Starting fee	Anfangsgebühr
monthlyFee	ans..16	O	Monthly fee	Monatliche Gebühr
totalAmount	ans..16	O	Total amount	Gesamtbetrag
installmentProfileNumber	ans..16	O	Installment profile number	Raten Profilnummer
readMore	ans..128	O	Further information about the installment process	Weitere Informationen zum Ratenprozess

Example of AllowedPaymentMethods as JSON string

Multiexcerpt

MultiExcerptName	JSON_AllowedPaymentMethods_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
      "paymentMethods" : [{
                  "type" : "Invoice"
            }, {
                  "type" : "Invoice",
                  "directDebit" : {
                        "available" : true
                  }
            }
      ]
}

Address

The information about corrected billing address data is defined here in an array if necessary.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647618578919_857324947
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_Address

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647618578921_-1370074724
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
countryCode	enum	M	Country code Possible values: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“	Ländercode Mögliche Werte: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“
postalCode	ans..10	M	Postal code	Postleitzahl
postalPlace	ans..100	M	City	Ort
Street	ans..100	M	Street or packstation	Straße oder Packstation
streetNumber	ans..10	M	Street number or packstation number	Haus- oder Packstationsnummer
streetNumberAdditional	ans..10	O	Street number addition	Hausnummernzusatz
careOf	ans..50	O	Responsible person for dispatch of shipment	Verantwortlicher für den Versand der Sendung

Example of Address as JSON string

Multiexcerpt

MultiExcerptName	JSON_Address_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
       [{
             "countryCode" : "DE",
             "postalCode" : "10405",
             "street" : "Prenzlauer Allee",
             "streetNumber" : 20
             "streetNumberAdditional" : "3. Stock",
             "postalPlace" : "Berlin",
             "addressType" : null,
             "careOf" : null
       }
      ]
}

OrderSummary

The OrderSummary information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647619306359_-146703723
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_OrderSummary

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647619306360_663009919
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
totalGrossAmount	ans..16	O	Gross order amount. Must equal the value of all items (grossUnitPrice * quantity). Please note, that values has to be specified with “.” as decimal separator.	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	Currency. Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“	Währung. Mögliche Werte sind „EUR“, „NOK“, „SEK“, „DKK“, „CHF“
items	Array	O	Array of OrderItems (see JSON object: OrderItem)	Array von OrderItems (siehe JSON-Objekt: OrderItem)
totalNetAmount	ans..16	O	Net order amount Please note, that values has to be specified with “.” as decimal separator.	Nettobetrag der Bestellung Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.	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	Google Analytics UserID
googleAnalyticsClientId	ans..64	O	Google Analytics ClientID	Google Analytics ClientID
discountAmount	ans..16	O	Discount amount (only for statistical purposes) Please note, that values has to be specified with “.” as decimal separator.	Rabattbetrag (nur für statistische Zwecke) Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

Example of OrderSummary as JSON string

Multiexcerpt

MultiExcerptName	JSON_OrderSummary_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
      "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

The information about dispatch is defined here in an array.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647619571938_968150424
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_ShippingData

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647619571940_-266848840
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
shippingDetails	Array	M	Array of shipping information (see JSON object: ShippingDetails)	Array von Versandinformationen (siehe JSON-Objekt: ShippingDetails)

ShippingDetails

The ShippingDetails information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647619747610_1415601192
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_ShippingDetails

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647619747612_-1692108077
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
type	enum	M	Dispatch type: Possible values are "Shipment", "Return"	Versandtyp: Mögliche Werte sind „Shipment“, „Return“
shippingCompany	ans..64	M	Shipping company	Versandunternehmen
trackingId	ans..64	M	Unique TrackingID	Eindeutige TrackingID

Example of ShippingData as JSON string

Multiexcerpt

MultiExcerptName	JSON_ShippingData_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

{
      "shippingDetails" : [{
                  "type" : "Shipment",
                  "shippingCompany" : "DHL",
                  "trackingId" : "234324234"
            }, {
                  "type" : "Shipment",
                  "shippingCompany" : "Hermes",
                  "trackingId" : "687654"
            }
      ]
}

RefundOrder

The information about the articles to be credited is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647619843488_1415601192
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_RefundOrder

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647619843490_-1692108077
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key	Format	CND	Description	Beschreibung
orderItems	Array	M	Array of articles to be credited (see JSON object: RefundOrderItem)	Array von Artikeln zum Gutschreiben (siehe JSON-Objekt: RefundOrderItem)

RefundOrderItem

The RefundOrderItem information is defined here.

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1647620028615_-713339473
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	JSON_RefundOrderItem

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1647620028617_-2029241524
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Key

Format

CND

Description

Beschreibung

refundType

ans..32

MC

Credit type: Possible values are "Refund“, "Return"

The parameter is not required for EventToken="Return".

Gutschriftstyp: Mögliche Werte sind „Refund“, „Return“

productId

ans..64

M

Article number

Artikelnummer

description

ans..128

M

Article description

Artikelbeschreibung

quantity

n..8

M

Article quantity

Decimal values, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

and AfterPay.

Artikelanzahl.

Dezimalwerte, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Partner-Name
PageWithExcerpt	DE:Wording

und AfterPay abgesprochen.

grossUnitPrice

ans..16

M

Gross price per article

Please note, that values has to be specified with “.” as decimal separator.

Bruttopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

groupId

ans..64

O

GroupID

GruppenID

netUnitPrice

ans..16

M

Net price per article

Please note, that values has to be specified with “.” as decimal separator.

Nettopreis pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

unitCode

ans..16

O

Unit (e.g. pieces, litres, kilograms, etc.)

Einheit (z.B. Stück, Liter, Kilogramm, etc.)

vatCategory

ans..32

O

VAT category

Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

Umsatzsteuerkategorie

Mögliche Werte: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

vatPercent

n..2

M

VAT in percent

Umsatzsteuer in Prozent

vatAmount

ans..16

M

VAT as amount per item

Please note, that values has to be specified with “.” as decimal separator.

Umsatzsteuer als Betrag pro Artikel

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

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

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

Kategorisierung des Händlers ergänzend zur Google-Klassifizierung

lineNumber

n.3

O

The merchant can specify a line number for each article for sorting purposes

Der Händler kann eine Zeilennummer für jeden Artikel angeben, um die Artikel zu sortieren

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

Rabattbetrag (nur für statistische Zwecke)

Bitte beachten Sie, dass Werte mit „.“ als Dezimaltrennzeichen anzugeben sind.

productUrl

ans..256

O

Article URL

URL zum Artikel

marketPlaceSellerId

ans..64

O

ID of a specific market place

ID eines bestimmten Marktplatzes

Example of RefundOrder as JSON string

Multiexcerpt

MultiExcerptName	JSON_RefundOrder_example
shouldDisplayInlineCommentsInIncludes	false

Code Block

language	json

[
           {
                  "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
            }
]

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 19

New Version 20

Key

About Afterpay

General information about Afterpay

Process Flow Chart

On this page

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Query about available payment types (two-stage authorisation)

Calling the interface for one-stage authorisation

Capture

Credit with reference

Reverse

Batch processing via the interface

JSON Objects

CustomerRisk

Example CustomerRisk as JSON string

Order

OrderRisk

OrderItem

Example of Order as JSON string

AllowedPayMethods

PaymentMethod

AccountProduct

DirectDebitInfo

CampaignInfo

InstallmentInfo

Example of AllowedPaymentMethods as JSON string

Address

Example of Address as JSON string

OrderSummary

Example of OrderSummary as JSON string

ShippingData

ShippingDetails

Example of ShippingData as JSON string

RefundOrder

RefundOrderItem

Example of RefundOrder as JSON string

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface