Skip to end of metadata
Go to start of metadata

"preauthorization" / "authorization"

Request 

Parameter

Required

Comments

clearingtype+Has to be "wlt"
wallettype+Has to be "PDT"
amount+

OrderAmount + ShippingAmount = amount

Maximum amount is limited to 5000000 (i.e. 50,000.00 Euro)

The transmitted amount in the preauthorization/authorization has to be equal to the amount in the add_paydata[action]=checkout request if you're performing an Express Checkout

currency+

Specifies currency for this transaction


Format

LIST

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

narrative_text-

is limited to 37 characters

Dynamic text element on account statements

Format

CHAR(1..81)

(3 lines with 27 characters each) and credit card statements.

emailo

is limited to 50 characters

Mandatory if "add_paydata[shopping_cart_type]=DIGITAL"

email-address of customer

Format

CHAR(5..254)
Permitted Symbols
RFC 5322

Special Remark email validation:

Max. length for email is 254 characters. Validation is set up in the following way:

  • Username = Max. 63 characters
  • Domain Name = Max. 63 characters
  • Domain Suffixes = Max. 4 suffixes with max. 124 characters 

Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]


"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.

add_paydata[over_capture]

-

Only valid with request "preauthorization"

Value “yes” will enable the overcapture function. The overcapture is restricted until 10% of the order amount.

Note: This function has to be activated by paydirekt.

add_paydata[minimum_age]

-

Minimum age of the customer for the order → see parameter add_paydata[redirect_url_after_age_verification_failure]

add_paydata[redirect_url_after_age_verification_failure]-

For use with parameter add_paydata[minimum_age]

Note: In case of a rejection “Error-URL” will be used if this URL was not transmitted

add_paydata[shopping_cart_type]

-

Value “DIGITAL” will change the shippingAddress parameters from mandatory to optional.

Note: The email address is mandatory for a DIGITAL shopping cart type

shipping_firstname

+

Mandatory for this type of payment, except "add_paydata[shopping_cart_type]=DIGITAL"

First name of delivery address

Format

CHAR(1..50)

shipping_lastname

+

Mandatory for this type of payment, except "add_paydata[shopping_cart_type]=DIGITAL"

Surname of delivery address

Format

CHAR(1..50)

shipping_company

-

Optional

Company Name of the delivery address

Format

CHAR(2..50)

shipping_street

-

Optional

Street number and name of delivery address

Format

CHAR(2..50)

shipping_zip

+

Mandatory for this type of payment, except "add_paydata[shopping_cart_type]=DIGITAL"

Postcode of delivery address

Format

CHAR(2..10)
Permitted Symbols
[0-9][A-Z][a-z][_.-/ ]

shipping_city

+

Mandatory for this type of payment, except "add_paydata[shopping_cart_type]=DIGITAL"

City of delivery address

Format

CHAR(2..50)

shipping_country+

Mandatory for this type of payment, except "add_paydata[shopping_cart_type]=DIGITAL"

Specifies country of delivery address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter shipping_state

successurl+

Mandatory for this type of payment

URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl+

Mandatory for this type of payment

URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl+

Mandatory for this type of payment

URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

"capture"

Request 

Additional Parameter

Required

Comments

capturemode+

Parameter "capturemode" is mandatory and must be used.

Specifies whether this capture is the last one or whether there will be another one in future.

Format

LIST
ValueComment
completed
  • Set with last capture; i.e.: Delivery completed.
  • No further capture is allowed.
notcompleted
  • Set with partial deliveries (last delivery with "completed")
  • Another capture is expected to complete the transaction.

Payment specific:

Payment typeComment

PDT

Parameter "capturemode" is mandatory.
KLS, KLVParameter "capturemode" is mandatory.


The default life time for the paydirekt checkout is 30 minutes. It is possible to set an expiry time for the checkout between 120 und 1800 seconds. Please contact the merchant service (Contact) if you want to limit the paydirekt checkout time.

Sequence Diagrams 

Sale

Order & Delivery

Returns

Reversal

  • No labels