Page tree
Skip to end of metadata
Go to start of metadata

paydirekt Express procedure

A purchase using paydirekt Express consists of at least three requests: 2 genericpayment requests and 1 preauthorization / authorization request.

Genericpayment requests:

add_paydata[action]=checkout initiates the paydirekt Express checkout. Paydirekt will respond all payment relevant data (e.g. the redirect-URL) following this request.

add_paydata[action]=getstatus requests the selected shipping data. After that, the customer will be redirected into the shop to complete the checkout.

"genericpayment – checkout"

Request 

Common Parameter

Required

Comments

amount+Value between 0 and 5000000
email-

email-address of customer

Format

CHAR(5..254)
Permitted Symbols
RFC 5322

currency+

Specifies currency for this transaction


Format

LIST 

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

add_paydata[action]

+Fixed value "checkout"

add_paydata[type]

+
  • for authorization: value "directsale"
  • for preauthorization: value "order"

add_paydata[web_url_shipping_terms]

+Link to merchant terms of delivery
add_paydata[invoice_reference_number]-

Merchant invoice number.

Note: This number can not be changed afterwards.

add_paydata[minimum_age]-Minimum age of the customer for the order
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

Shopping cart



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.

it[n]

+

Parameter it[n] specifies the item type of a shopping cart item.

Format

LIST 

Array

Array elements [n] starting with [1]; serially numbered; max [400]


it[n]

Comments


goodsGoods
shipment

Shipping charges


handling

Handling fee

  • Not to be used with PDT
voucherVoucher / discount
  • Not to be used with PDT
id[n]-

International Article Number (EAN bzw. GTIN)

Product number, SKU, etc. of this item

Format

CHAR(1..32)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

pr[n]+

Unit gross price of the item in smallest unit! e.g. cent

Format

NUMERIC(10) max. 19 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [400]

no[n]+

Quantity ???? oder 6-stellig ????

Quantity of this item

Format

NUMERIC(6)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

de[n]+

Description

Description of this item. Will be printed on documents to customer.

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[400]=Product 400

Redirect



successurl

+

URL "payment successful"

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+

URL "payment faulty"

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+

URL "Back" or "Cancel"

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}

Example

add_paydata[action]=checkout
add_paydata[type]=directsale
add_paydata[web_url_shipping_terms]=http://www.payone.com/termsofdelivery
aid=12345 (your aid)
amount=13110
api_version=3.10
backurl=https://payone.de/PayoneCheckout/steps/PaydirektGetStatus.php?return=back
clearingtype=wlt
currency=EUR
email=test@payone.de
encoding=UTF-8
errorurl=https://payone.de/PayoneCheckout/steps/PaydirektGetStatus.php?return=error
key=abcdefghijklmn123456789 (your key)
mid=12345 (your mid)
mode=test (set to „live“ for live-requests)
param=10.0.10.125
portalid=1234567
request=genericpayment
solution_name=SDK
solution_version=0.2
successurl=https://payone.de/PayoneCheckout/steps/PaydirektGetStatus.php?return=success
wallettype=PDT
it[1]=goods
it[2]=goods
it[3]=goods
it[4]=shipment
id[1]=hammer0234
id[2]=socks1
id[3]=boat66
id[4]=PATSY_PAKET
pr[1]=100
pr[2]=2340
pr[3]=8540
pr[4]=599
no[1]=3
no[2]=1
no[3]=1
no[8]=1
de[1]=the one and only hammer
de[2]=the socks for the bold an the beautiful
de[3]=my boat and not yours
de[4]=Lieferung von P.a.t.Sy

Response 

Common Parameter

Required

Comments

status+REDIRECT / ERROR

Parameter ( REDIRECT )



redirecturl+

Redirect URL → zMerchant system has to redirect customer to this URL to complete payment

Format

CHAR(2..2000)

add_paydata[workorderid]+Has to be used for following "preauthorization" / "authorization"
workorderid+

Has to be used for following "preauthorization" / "authorization" (always same value as above)

The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.

Format

CHAR(1..50)

Parameter ( ERROR )



errorcode+

Error number

In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+

Error message for the merchant

In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)

customermessage

+

Error message for the customer

The customermessage is returned to your system in order to be displayed to the customer.

(Language selection is based on the end customer's language, parameter "language")

Format

CHAR(1..1024)

Example

status=REDIRECT
redirecturl=https://paydirekt.de/checkout/#/checkout/dcb593d5-b8f5-429f-ab0d-ff125471c264
add_paydata[workorderid]=ABCDEFG1234567
workorderid=ABCDEFG1234567


"genericpayment – getstatus"

Request 

Common Parameter

Required

Comments

workorderid

+

Payment process identifier

The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.

Format

CHAR(1..50)

add_paydata[action]+Fixed value "getstatus"

Example

add_paydata[action]=getstatus
aid=12345 (your aid)
amount=13110
api_version=3.10
clearingtype=wlt
currency=EUR
encoding=UTF-8
key=abcdefghijklmn123456789 (your key)
mid=12345 (your mid)
mode=test (set to „live“ for live-requests)
param=10.0.4.82
portalid=1234567
request=genericpayment
solution_name=SDK
solution_version=0.2
wallettype=PDT
workorderid=ABCDEFG1234567

Response 

Parameter

Required

Comment

add_paydata[shipping_firstname]

+

Chosen DeliveryOption: Firstname

add_paydata[shipping_lastname]

+

Chosen DeliveryOption: Lastname

add_paydata[shipping_streetname]

+

Chosen DeliveryOption: Streetname

add_paydata[shipping_streetnumber]

+

Chosen DeliveryOption: Streetnumber

add_paydata[shipping_city]

+

Chosen DeliveryOption: City

add_paydata[shipping_zip]

+

Chosen DeliveryOption: Zip Code

add_paydata[shipping_country]

+

Chosen DeliveryOption: Country

add_paydata[shipping_company]

-

Chosen DeliveryOption: Company

add_paydata[shipping_additionaladdressinformation]

-

Chosen DeliveryOption: Additional information

add_paydata[shipping_email]

-

Chosen DeliveryOption: Email

add_paydata[billing_firstname]

+

Chosen InvoiceOption: Firstname

add_paydata[billing_lastname]

+

Chosen InvoiceOption: Lastname

add_paydata[billing_streetname]

+

Chosen InvoiceOption: Streetname

add_paydata[billing_streetnumber]

+

Chosen InvoiceOption: Streetnumber

add_paydata[billing_city]

+

Chosen InvoiceOption: City

add_paydata[billing_zip]

+

Chosen InvoiceOption: Zip Code

add_paydata[billing_country]

+

Chosen InvoiceOption: Country

add_paydata[billing_company]

-

Chosen InvoiceOption: Company

add_paydata[billing_additionaladdressinformation]

-

Chosen InvoiceOption: Additional Information

add_paydata[billing_email]

-

Chosen InvoiceOption: Email

add_paydata[buyer_email]

+

The customer e-mail address from the paydirekt account.

Example

status=OK
add_paydata[shipping_streetname]=Fuchsweg
add_paydata[shipping_country]=DE
add_paydata[shipping_city]=Weißenburg i. Bay.
add_paydata[shipping_streetnumber]=10b
add_paydata[billing_lastname]=Mustermannn
add_paydata[billing_country]=DE
add_paydata[shipping_firstname]=Marie
add_paydata[billing_streetname]=Fuchsweg
add_paydata[billing_city]=Weißenburg i. Bay.
add_paydata[workorderid]=ABCDEFG1234567
add_paydata[shipping_zip]=91781
add_paydata[billing_firstname]=Marie
add_paydata[billing_streetnumber]=10b
add_paydata[billing_zip]=91781
add_paydata[shipping_lastname]=Mustermannn
add_paydata[buyer_email]=test@payone.de
workorderid=ABCDEFG1234567

Preauthorization/authorization

Request

Parameter

Required

Comment

workorderid

+

Payment process identifier

The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.

Format

CHAR(1..50)

amount

+

OrderAmount + ShippingAmount = amount

 

Note: The transmitted amount in the preauthorization/authorization has to be equal to the amount in the add_paydata[action]=checkoutrequest.

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.

Format

NUMERIC(1..10)

Permitted values

max. +/- 19 999 999 99

add_paydata[terms_accepted_timestamp]

+

ISO-8601 (e.g. 2017-05-26T08:49:46Z)

 Example Request

 add_paydata[terms_accepted_timestamp]=2017-08-04T09:51:05Z
 aid=12345 (your aid)
 amount=13709
 api_version=3.10
 backurl=https://payone.de/PayoneCheckout/steps/ExecutePayment.php?return=back
 city=Weißenburg i. Bay.
 clearingtype=wlt
 country=DE
 currency=EUR
 de[1]=the one and only hammer
 de[2]=the socks for the bold an the beautiful
 de[3]=my boat and not yours
 de[4]=Lieferung von P.a.t.Sy
 encoding=UTF-8
 errorurl=https://payone.de/PayoneCheckout/steps/ExecutePayment.php?return=error
 firstname=Marie
 id[1]=hammer0234
 id[2]=socks1
 id[3]=boat66
 id[4]=PATSY_PAKET
 integrator_name=tk
 integrator_version=0.2
 it[1]=goods
 it[2]=goods
 it[3]=goods
 it[4]=shipment
 key=abcdefghijklmn123456789 (your key)
 lastname=Mustermannn
 mid=12345 (your mid)
 mode=test (set to „live“ for live-requests)
 narrative_text=0123456789012345678901234567890123456789
 no[1]=3
 no[2]=1
 no[3]=1
 no[8]=1
 param=10.0.10.125
 portalid=1234567
 pr[1]=100
 pr[2]=2340
 pr[3]=8540
 pr[4]=599
 reference=R15018402651238
 request=authorization
 shipping_city=Weißenburg i. Bay.
 shipping_country=DE
 shipping_firstname=Marie
 shipping_lastname=Mustermannn
 shipping_street=Fuchsweg 10b
 shipping_zip=91781
 solution_name=SDK
 solution_version=0.2
 street=Fuchsweg 10b
 successurl=https://payone.de/PayoneCheckout/steps/ExecutePayment.php?return=success
 va[1]=1900
 va[2]=1900
 va[3]=1900
 va[4]=1900
 wallettype=PDT
 workorderid=ABCDEFG1234567
 zip=91781


Example Response

status=APPROVED
txid=23456789
userid=123456789

Sequence Diagrams 

Sale

Order & Delivery


  • No labels