PayPal provides merchants with the capability to securely store customer data in their Vault. This feature offers several advantages for both merchants and customers. For merchants, the PayPal Vault facilitates the management of subscription-based billing agreements, allowing for seamless and automated recurring payments. This means that merchants can initiate subsequent transactions without requiring further action from the customer.
For customers, utilizing the PayPal Vault enhances their shopping experience by enabling them to complete purchases without having to log in to PayPal again for verification. Once their payment information is securely stored, they can expedite the checkout process on future orders. This not only provides convenience but also promotes customer retention and satisfaction by making repeat purchases more straightforward and efficient.
---end
---end
PayPal offers two variations to store customer data.
The PayPal JavaScript SDK can also be utilized to render buttons for Vaulted Transactions. This includes supporting both billing agreement signups and setting up payment flows, providing a seamless and efficient transaction process for customers and merchants alike. For more information on rendering the PayPal buttons via Javascript SDK please use our implementaiton guide
---end
---end
POST Request - Pre-/ Authorization
| request
required
|
Fixed Value: preauthorization / authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
---end
| amount
required
|
Format NUMERIC(0..1)
in this scenario only 0 or 0.01 EUR so 0 or 1 Cent is used.
Specifies the total gross amount of a payment transaction. For Vault Setup without transaction 0 as total amount is allowed. 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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
---end
| customerid optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
| userid optional
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
| salutation optional
|
Format CHAR(1..10)
The customer's salutation |
| title optional
|
Format CHAR(1..20)
Samples Dr / Prof. / Dr.-Ing. Title of the customer |
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| lastname
required
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
| addressaddition optional
|
Format CHAR(1..50)
Samples 7th floor c/o Maier Specifies an additional address line for the invoice address of the customer. |
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
| city optional
|
Format CHAR(2..50)
City of customer |
| country
required
|
Fixed Value DE
|
| email optional
|
Format CHAR(5..254)
Mandatory if "add_paydata[shopping_cart_type]=DIGITAL" 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 "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
| birthday optional
|
Format DATE(8), YYYYMMDD
Samples 20190101 / 19991231 Date of birth of customer |
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
| vatid optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
| gender optional
|
Format LIST
Permitted values f / m / d Gender of customer (female / male / diverse* ) * currently not in use |
| personalid optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()] Person specific numbers or characters, e.g. number of passport / ID card |
| ip optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
---end
| shipping_firstname required
|
Format CHAR(1..50)
First name of delivery address |
||||||||
| shipping_lastname required
|
Format CHAR(1..50)
Surname of delivery address |
||||||||
| shipping_company optional
|
Format CHAR(2..50)
Company name of delivery address |
||||||||
| shipping_street optional
|
Format CHAR(2..50)
Street number and name of delivery address |
||||||||
| shipping_zip required
|
Format CHAR(2..50)
Postcode of delivery address |
||||||||
| shipping_addressaddition optional
|
Format CHAR(1..50)
Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier". |
||||||||
| shipping_country optional
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples DE / GB / US Specifies country of address for the customer. Some countries require additional information in parameter "state" |
||||||||
| shipping_state optional
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
|
---end
| wallettype required
|
Fixed Value: PAL
|
| clearingtype
required
|
Fixed Value: wlt
|
| recurrence
required
|
Fixed Value: oneclick
Marks the payment as a recurring Payment setup, customer initiated Transaction or Merchant initiated Transaction |
| customer_is_present
required
|
Fixed Value: yes / no
Mandatory field when the transaction is recurring. Marking the Transaction as customer initiated (yes) or merchant ininitated (no) |
| successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
| errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
| backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
|
add_paydata[risk_session_correlation_id]
optional
|
Format CHAR(2..255)
This id is generated through FraudNet Library. Please use this parameter to send the value PayPal for fraud prevention purposes. |
---end
| status
required
|
Permitted Values
REDIRECT
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
|
Format CHAR(2..2000)
Redirect URL → zMerchant system has to redirect customer to this URL to complete payment |
---
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
|
Format CHAR(1..1024)
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") |
---end
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid: 23456 (your mid)
portalid: 12345123 (your portalid)
key: abcdefghijklmn123456789 (your key)
api_version: 3.11
mode: test (set to „live“ for live-requests)
request: preauthorization
encoding: UTF-8
aid: 12345 (your aid)
clearingtype: wlt
reference: Ref123456
amount: 1,
currency: EUR,
language: de,
wallettype: PAL,
recurrence: oneclick,
customer_is_present: yes,
add_paydata[risk_session_correlation_id]: usertest,
firstname: Maximilian,
lastname: Maximilian,
street: Mustergasse 3,
country: DE,
city: Berlin,
zip: 12345,
email: pui-testGast@payone.de,
shipping_firstname: Maximilian,
shipping_lastname: Maximilian,
shipping_street: Mustergasse 3,
shipping_country: DE,
shipping_city: Berlin,
shipping_zip: 12345,
successurl: https: //paypal.pay1-test.de/success.php,
errorurl: https: //paypal.pay1-test.de/error-php,
backurl: https: //paypal.pay1-test.de/error-php
RESPONSE
status: REDIRECT,
txid: 1202857511,
userid: 27973375,
redirecturl: https: //sandbox.paypal.com/agreements/approve?approval_session_id,
add_paydata[setupTokenId]: 88R06586J70184500,
add_paydata[workorderid]: PP2AAD78Y4JPBE90
POST Request - genericpayment – add_paydata[action] = confirm_order_status
This has to be added if the SDK is used.
|
request
required
|
Fixed Value: preauthorization / authorization
|
|
mid
required
|
your merchant ID, 5-digit numeric
|
|
aid
required
|
your subaccount ID, 5-digit numeric
|
|
portalId
required
|
your Portal ID, 7-digit numeric
|
|
key
required
|
your key value, alpha-numeric
|
---end
|
mode
required
|
Fixed Value: test/live
Can be either test environment (test) or live environment (live) |
|
reference
optional
|
Format CHAR(2..255)
A unique ID that will be displayed in your shop backend and for the customer |
|
currency
required
|
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples
EUR / USD / GBP |
|
workorderid
required
|
Format CHAR(1..50)
The ID is unique. The returned workorderid is mandatory for the following requests of PayPal Express Checkout. 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. |
|
language
optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
|
wallettype
required
|
Fixed Value PAL
|
|
successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
|
errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
|
backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
|
add_paydata[action]
required
|
Fixed Value: confirm_order
|
---end
|
status
required
|
Permitted Values
OK / ERROR
|
|
workorderid
|
Format AN(1..16)
The ID is unique. The returned workorderid is mandatory for the following requests of PayPal Express Checkout. 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. |
---
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
request: genericpayment,
mid: 18323,
aid: 18324,
portalid: 2013285,
key: 1856f15989f3df533f77f294a6871c2a,
add_paydata[payment_action]: your payment action
add_paydata[action]: update_order,
add_paydata[request_id]: 73851048-867f-4f1b-be4a-4daafa2ef999,
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 2000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
successurl: https: //pay1-test.de/api_test.php?exit=success&txid=__txid__,
backurl: https: //pay1-test.de/api_test.php?exit=back,
errorurl: https: //pay1-test.de/api_test.php?exit=error&errorcode=__errorcode__,
encoding: UTF-8,
language: de,
email: email@email.com,
telephonenumber: 49123456789,
currency: EUR,
workorderid: PP2AAD7924U0PV3H,
clearingtype: wlt,
wallettype: PAL,
customerid: 13377331,
amount: 1100,
mode: test
RESPONSE
status=OK
workorderid: PP2AAD7924U0PV3H
---end
---end
POST Request - Pre-/ Authorization
| request
required
|
Fixed Value: preauthorization / authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
---end
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
---end
| customerid optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
| userid optional
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
| salutation optional
|
Format CHAR(1..10)
The customer's salutation |
| title optional
|
Format CHAR(1..20)
Samples Dr / Prof. / Dr.-Ing. Title of the customer |
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| lastname
required
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
| addressaddition optional
|
Format CHAR(1..50)
Samples 7th floor / c/o Maier Specifies an additional address line for the invoice address of the customer. |
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
| city optional
|
Format CHAR(2..50)
City of customer |
| country
required
|
Fixed Value DE
|
| email optional
|
Format CHAR(5..254)
Mandatory if "add_paydata[shopping_cart_type]=DIGITAL" 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 "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
| birthday optional
|
Format DATE(8), YYYYMMDD
Date of birth of customer |
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
| vatid optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
| gender optional
|
Format LIST
Permitted values f / m / d Gender of customer (female / male / diverse* ) * currently not in use |
| personalid optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()] Person specific numbers or characters, e.g. number of passport / ID card |
| ip optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
---end
| shipping_firstname required
|
Format CHAR(1..50)
First name of delivery address |
||||||||
| shipping_lastname required
|
Format CHAR(1..50)
Surname of delivery address |
||||||||
| shipping_company optional
|
Format CHAR(2..50)
Company name of delivery address |
||||||||
| shipping_street optional
|
Format CHAR(2..50)
Street number and name of delivery address |
||||||||
| shipping_zip required
|
Format CHAR(2..50)
Postcode of delivery address |
||||||||
| shipping_addressaddition optional
|
Format CHAR(1..50)
Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier". |
||||||||
| shipping_country optional
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples DE / GB / US Specifies country of address for the customer. Some countries require additional information in parameter "state" |
||||||||
| shipping_state optional
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
|
---end
| wallettype required
|
Fixed Value: PAL
|
| clearingtype
required
|
Fixed Value: wlt
|
| recurrence
required
|
Fixed Value: oneclick
Marks the payment as a recurring Payment setup, customer initiated Transaction or Merchant initiated Transaction
|
| customer_is_present
required
|
Fixed Value: yes/no
Mandatory field when the transaction is recurring. Marking the Transaction as customer initiated (yes) or merchant ininitated (no)
|
| successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
| errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
| backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
| it[n] optional
|
|
||||||||||
| id[n] optional
|
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/
International Article Number (EAN bzw. GTIN) Product number, SKU, etc. of this item |
||||||||||
| pr[n] optional
|
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted
Unit gross price of the item in smallest unit! e.g. cent |
||||||||||
| no[n] optional
|
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Quantity of this item |
||||||||||
| de[n] optional
|
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Description of this item. Will be printed on documents to customer. |
||||||||||
| va[n] optional
|
Format NUMERIC(4)
VAT rate (% or bp) Array elements [n] starting with [1]; serially numbered; max [400] |
---end
|
add_paydata[over_capture]
optional
|
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]
optional
|
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]
optional
|
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]
optional
|
Value “DIGITAL” will change the shippingAddress parameters from mandatory to optional.
Note: The email address is mandatory for |
---end
| status
required
|
Permitted Values
REDIRECT
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
|
Format CHAR(2..2000)
Redirect URL → zMerchant system has to redirect customer to this URL to complete payment |
---
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
|
Format CHAR(1..1024)
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") |
---end
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.11
mode=test (set to „live“ for live-requests)
request=preauthorization
encoding=UTF-8
clearingtype: wlt,
reference: yourreference,
language: de,
wallettype: PAL,
recurrence: oneclick,
customer_is_present: yes,
add_paydata[risk_session_correlation_id]: usertest
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR
firstname: Maximilian,
lastname: Maximilian,
street: Heinestrasse3,
country: DE,
city: Berlin,
zip: 12345,
email: Kunde@kundentest.de,
shipping_firstname: Maximilian,
shipping_lastname: Maximilian,
shipping_street: Heinestrasse3,
shipping_country: DE,
shipping_city: Berlin,
shipping_zip: 12345,
successurl: https: //paypal.pay1-test.de/success.php,
errorurl: https: //paypal.pay1-test.de/error-php,
backurl: https: //paypal.pay1-test.de/error-php
RESPONSE
status: REDIRECT,
txid: 1202857530,
userid: 27973394,
redirecturl: https: //www.sandbox.paypal.com/checkoutnow?token,
add_paydata[orderId]: 2FH99840NY6765531,
add_paydata[workorderid]: PP2AAD7ZX0VTZHR1
POST Request - genericpayment – add_paydata[action] = confirm_order_status
This has to be added if the SDK is used.
|
request
required
|
Fixed Value: preauthorization / authorization
|
|
mid
required
|
your merchant ID, 5-digit numeric
|
|
aid
required
|
your subaccount ID, 5-digit numeric
|
|
portalId
required
|
your Portal ID, 7-digit numeric
|
|
key
required
|
your key value, alpha-numeric
|
---end
|
mode
required
|
Fixed Value: test/live
Can be either test environment (test) or live environment (live) |
|
reference
optional
|
Format CHAR(2..255)
A unique ID that will be displayed in your shop backend and for the customer |
|
currency
required
|
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples
EUR / USD / GBP |
|
workorderid
required
|
Format CHAR(1..50)
The ID is unique. The returned workorderid is mandatory for the following requests of PayPal Express Checkout. 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. |
|
language
optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
|
wallettype
required
|
Fixed Value PAL
|
|
successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
|
errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
|
backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
|
add_paydata[action]
required
|
Fixed Value: confirm_order
|
---end
|
status
required
|
Permitted Values
OK / ERROR
|
|
workorderid
|
Format AN(1..16)
The ID is unique. The returned workorderid is mandatory for the following requests of PayPal Express Checkout. 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. |
---
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
request: genericpayment,
mid: 18323,
aid: 18324,
portalid: 2013285,
key: 1856f15989f3df533f77f294a6871c2a,
add_paydata[payment_action]: your payment action
add_paydata[action]: update_order,
add_paydata[request_id]: 73851048-867f-4f1b-be4a-4daafa2ef999,
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 2000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
successurl: https: //pay1-test.de/api_test.php?exit=success&txid=__txid__,
backurl: https: //pay1-test.de/api_test.php?exit=back,
errorurl: https: //pay1-test.de/api_test.php?exit=error&errorcode=__errorcode__,
encoding: UTF-8,
language: de,
email: email@email.com,
telephonenumber: 49123456789,
currency: EUR,
workorderid: PP2AAD7924U0PV3H,
clearingtype: wlt,
wallettype: PAL,
customerid: 13377331,
amount: 1100,
mode: test
RESPONSE
status=OK
workorderid: PP2AAD7924U0PV3H
---end
POST Request - Capture
| request
required
|
Fixed Value: capture
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
| sequencenumber
optional
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
| currency
required
|
Fixed Value EUR
|
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|||||||
| add_paydata[capture_id] |
Format CHAR(16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR,
sequencenumber: 1,
settleaccount: auto,
txid: 1202830913
RESPONSE
status: APPROVED,
txid: 1202830913,
add_paydata[capture_id]: TX2AAD7XN4UFGG9X,
settleaccount: yes
POST Request - Debit
| request
required
|
Fixed Value: debit
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
| sequencenumber
required
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
||||||
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
|
add_paydata[capture_id]
optional
|
Fixed Char(1..16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
txid
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
|
settleaccount
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456
portalid=12345123
key=abcdefghijklmn123456789
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
request: refund,
aid: 54321,
sequencenumber: 2,
txid: 1202830913,
amount: -20500,
currency: EUR
RESPONSE
status: APPROVED,
txid: 1202830913
---end
After the initial Setup the Payments using the stored data can be used for recurring payments or just stored customer data in case the customer is a regular and often purchases items. On regular subscription based recurring payments the customer does not have to be present
POST Request - Pre-/ Authorization
| request
required
|
Fixed Value: preauthorization / authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
---end
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
---end
| customerid optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
| userid required
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
| salutation optional
|
Format CHAR(1..10)
The customer's salutation |
| title optional
|
Format CHAR(1..20)
Samples Dr / Prof. / Dr.-Ing. Title of the customer |
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| lastname
optional
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
| addressaddition optional
|
Format CHAR(1..50)
Samples 7th floor / c/o Maier Specifies an additional address line for the invoice address of the customer. |
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
| city optional
|
Format CHAR(2..50)
City of customer |
| country
required
|
Fixed Value DE
|
| email optional
|
Format CHAR(5..254)
Mandatory if "add_paydata[shopping_cart_type]=DIGITAL" 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 "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
| birthday optional
|
Format DATE(8), YYYYMMDD
Date of birth of customer |
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
| vatid optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
| gender optional
|
Format LIST
Permitted values f / m / d Gender of customer (female / male / diverse* ) * currently not in use |
| personalid optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()] Person specific numbers or characters, e.g. number of passport / ID card |
| ip optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
---end
| shipping_firstname required
|
Format CHAR(1..50)
First name of delivery address, required for physical goods |
||||||||
| shipping_lastname required
|
Format CHAR(1..50)
Surname of delivery address, required for physical goods |
||||||||
| shipping_company optional
|
Format CHAR(2..50)
Company name of delivery address, required for physical goods |
||||||||
| shipping_street optional
|
Format CHAR(2..50)
Street number and name of delivery address, required for physical goods |
||||||||
| shipping_zip required
|
Format CHAR(2..50)
Postcode of delivery address, required for physical goods |
||||||||
| shipping_addressaddition optional
|
Format CHAR(1..50)
Specifies an additional address line for the delivery address of the customer, required for physical goods, e.g. "7th floor", "c/o Maier". |
||||||||
| shipping_country optional
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples DE / GB / US Specifies country of address for the customer. Some countries require additional information in parameter "state" |
||||||||
| shipping_state optional
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
|
---end
| wallettype required
|
Fixed Value: PAL
|
| clearingtype
required
|
Fixed Value: wlt
|
| recurrence
required
|
Fixed Value: recurring
Marks the payment as a recurring Payment setup, customer initiated Transaction or Merchant initiated Transaction
|
| customer_is_present
required
|
Fixed Value: no
Mandatory field when the transaction is recurring. Marking the Transaction as customer initiated or merchant ininitated.
|
| successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
| errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
| backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
| it[n] optional
|
|
||||||||||
| id[n] optional
|
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/
International Article Number (EAN bzw. GTIN) Product number, SKU, etc. of this item |
||||||||||
| pr[n] optional
|
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted
Unit gross price of the item in smallest unit! e.g. cent |
||||||||||
| no[n] optional
|
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Quantity of this item |
||||||||||
| de[n] optional
|
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Description of this item. Will be printed on documents to customer. |
||||||||||
| va[n] optional
|
Format NUMERIC(4)
VAT rate (% or bp) Array elements [n] starting with [1]; serially numbered; max [400] |
---end
|
add_paydata[risk_session_correlation_id]
required
|
This value is given back when initating the Fraudnet libary and is mandatory |
---end
| status
required
|
Permitted Values
APPROVED
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
| add_paydata[workorderid] |
Format CHAR(1..50)
The ID is unique. The returned workorderid is mandatory for some future requests. 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 NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
|
Format CHAR(1..1024)
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") |
---end
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.11
mode=test (set to „live“ for live-requests)
request=preauthorization
encoding=UTF-8
clearingtype: wlt,
reference: yourreference,
language: de,
wallettype: PAL,
recurrence: recurring,
customer_is_present: yes,
add_paydata[risk_session_correlation_id]: usertest
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR
firstname: Maximilian,
lastname: Maximilian,
street: Heinestrasse3,
country: DE,
city: Berlin,
zip: 12345,
email: pui-testGast@payone.de,
shipping_firstname: Maximilian,
shipping_lastname: Maximilian,
shipping_street: Heinestrasse3,
shipping_country: DE,
shipping_city: Berlin,
shipping_zip: 12345,
successurl: https: //paypal.pay1-test.de/success.php,
errorurl: https: //paypal.pay1-test.de/error-php,
backurl: https: //paypal.pay1-test.de/error-php
RESPONSE
status: REDIRECT,
txid: 1202857530,
userid: 27973394,
redirecturl: https: //www.sandbox.paypal.com/checkoutnow?token,
add_paydata[orderId]: 2FH99840NY6765531,
add_paydata[workorderid]: PP2AAD7ZX0VTZHR1
POST Request - Capture
| request
required
|
Fixed Value: capture
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
| sequencenumber
optional
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
| currency
required
|
Fixed Value EUR
|
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|||||||
| add_paydata[capture_id] |
Format CHAR(16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR,
sequencenumber: 1,
settleaccount: auto,
txid: 1202830913
RESPONSE
status: APPROVED,
txid: 1202830913,
add_paydata[capture_id]: TX2AAD7XN4UFGG9X,
settleaccount: yes
POST Request - Debit
| request
required
|
Fixed Value: debit
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
| sequencenumber
required
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
||||||
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
|
add_paydata[capture_id]
optional
|
Fixed Char(1..16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
txid
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
|
settleaccount
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456
portalid=12345123
key=abcdefghijklmn123456789
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
request: refund,
aid: 54321,
sequencenumber: 2,
txid: 1202830913,
amount: -20500,
currency: EUR
RESPONSE
status: APPROVED,
txid: 1202830913
---end
POST Request - Pre-/ Authorization
| request
required
|
Fixed Value: preauthorization / authorization
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
---end
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
---end
| customerid optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
| userid required
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
| salutation optional
|
Format CHAR(1..10)
The customer's salutation |
| title optional
|
Format CHAR(1..20)
Samples Dr / Prof. / Dr.-Ing. Title of the customer |
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| lastname
required
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
| addressaddition optional
|
Format CHAR(1..50)
Samples 7th floor / c/o Maier Specifies an additional address line for the invoice address of the customer. |
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
| city optional
|
Format CHAR(2..50)
City of customer |
| country
required
|
Fixed Value DE
|
| email optional
|
Format CHAR(5..254)
Mandatory if "add_paydata[shopping_cart_type]=DIGITAL" 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 "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
| birthday optional
|
Format DATE(8), YYYYMMDD
Date of birth of customer |
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. |
| vatid optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
| gender optional
|
Format LIST
Permitted values f / m / d Gender of customer (female / male / diverse* ) * currently not in use |
| personalid optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()] Person specific numbers or characters, e.g. number of passport / ID card |
| ip optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
---end
| shipping_firstname required
|
Format CHAR(1..50)
First name of delivery address |
||||||||
| shipping_lastname required
|
Format CHAR(1..50)
Surname of delivery address |
||||||||
| shipping_company optional
|
Format CHAR(2..50)
Company name of delivery address |
||||||||
| shipping_street optional
|
Format CHAR(2..50)
Street number and name of delivery address |
||||||||
| shipping_zip required
|
Format CHAR(2..50)
Postcode of delivery address |
||||||||
| shipping_addressaddition optional
|
Format CHAR(1..50)
Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier". |
||||||||
| shipping_country optional
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples DE / GB / US Specifies country of address for the customer. Some countries require additional information in parameter "state" |
||||||||
| shipping_state optional
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
|
---end
| wallettype required
|
Fixed Value: PAL
|
| clearingtype
required
|
Fixed Value: wlt
|
| recurrence
required
|
Fixed Value: recurring
Marks the payment as a recurring Payment setup, customer initiated Transaction or Merchant initiated Transaction
|
| customer_is_present
required
|
Fixed Value: no
Mandatory field when the transaction is recurring. Marking the Transaction as customer initiated or merchant ininitated
|
| successurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "payment successful" |
| errorurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "faulty payment" |
| backurl
required
|
Format CHAR(2..255)
Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
URL for "Back" or "Cancel" |
---end
| it[n] optional
|
|
||||||||||
| id[n] optional
|
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/
International Article Number (EAN bzw. GTIN) Product number, SKU, etc. of this item |
||||||||||
| pr[n] optional
|
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted
Unit gross price of the item in smallest unit! e.g. cent |
||||||||||
| no[n] optional
|
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Quantity of this item |
||||||||||
| de[n] optional
|
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Description of this item. Will be printed on documents to customer. |
||||||||||
| va[n] optional
|
Format NUMERIC(4)
VAT rate (% or bp) Array elements [n] starting with [1]; serially numbered; max [400] |
---end
|
add_paydata[redirection_mode]
optional
|
Redirect to the merchant page
|
---end
| status
required
|
Permitted Values
APPROVED
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
| add_paydata[workorderid] |
Format CHAR(1..50)
The ID is unique. The returned workorderid is mandatory for some future requests. 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 NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
|
Format CHAR(1..1024)
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") |
---end
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.11
mode=test (set to „live“ for live-requests)
request=preauthorization
encoding=UTF-8
clearingtype: wlt,
reference: yourreference,
language: de,
wallettype: PAL,
recurrence: recurring,
customer_is_present: yes,
add_paydata[risk_session_correlation_id]: usertest
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR
firstname: Maximilian,
lastname: Maximilian,
street: Heinestrasse3,
country: DE,
city: Berlin,
zip: 12345,
email: pui-testGast@payone.de,
shipping_firstname: Maximilian,
shipping_lastname: Maximilian,
shipping_street: Heinestrasse3,
shipping_country: DE,
shipping_city: Berlin,
shipping_zip: 12345,
successurl: https: //paypal.pay1-test.de/success.php,
errorurl: https: //paypal.pay1-test.de/error-php,
backurl: https: //paypal.pay1-test.de/error-php
RESPONSE
status: REDIRECT,
txid: 1202857530,
userid: 27973394,
redirecturl: https: //www.sandbox.paypal.com/checkoutnow?token,
add_paydata[orderId]: 2FH99840NY6765531,
add_paydata[workorderid]: PP2AAD7ZX0VTZHR1
POST Request - Capture
| request
required
|
Fixed Value: capture
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
| sequencenumber
optional
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
| currency
required
|
Fixed Value EUR
|
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|||||||
| add_paydata[capture_id] |
Format CHAR(16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
|
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
id[n]: 1001001,
id[n+1]: 1001002,
it[n]: goods,
it[n+1]: shipment,
no[n]: 1,
no[n+1]: 1,
pr[n]: 20000,
pr[n+1]: 500,
de[n]: Testartikel1,
de[n+1]: Transport,
va[n]: 19,
va[n+1]: 19,
amount: 20500,
currency: EUR,
sequencenumber: 1,
settleaccount: auto,
txid: 1202830913
RESPONSE
status: APPROVED,
txid: 1202830913,
add_paydata[capture_id]: TX2AAD7XN4UFGG9X,
settleaccount: yes
POST Request - Debit
| request
required
|
Fixed Value: debit
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| txid
required
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
| sequencenumber
required
|
Format NUMERIC(1..3)
Permitted values 0..127
Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) |
||||||
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99
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. |
||||||
| currency
required
|
Fixed Value EUR
|
||||||
| narrative_text
optional
|
Format CHAR(1..81)
Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements. |
||||||
|
add_paydata[capture_id]
optional
|
Fixed Char(1..16)
The capture ID can be used for multiple captures and refunds, to connect a specific refund to a specific capture |
||||||
| use_customerdata
optional
|
Format LIST
Use account details from debtor's master data |
||||||
| transaction_param
optional
|
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/] Optional parameter for merchant information (per payment request) |
|
Permitted Values
APPROVED
PENDING
ERROR
|
|
txid
|
Format NUMERIC(9..12)
The txid specifies the payment process within the PAYONE platform |
||||||
|
settleaccount
|
Format LIST
Provides information about whether a settlement of balances has been carried out. |
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
mid=23456
portalid=12345123
key=abcdefghijklmn123456789
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8
request: refund,
aid: 54321,
sequencenumber: 2,
txid: 1202830913,
amount: -20500,
currency: EUR
RESPONSE
status: APPROVED,
txid: 1202830913
---end
FraudNet, developed by PayPal, is a JavaScript library embedded into a merchant’s web page to gather browser-based data aimed at minimizing fraud. During the checkout process, data elements are transmitted to PayPal Risk Services for comprehensive fraud and risk evaluation. Please note that FraudNet is designed exclusively for desktop browsers.
The data collected by FraudNet is utilized for risk analysis and authentication purposes. Rest assured, PayPal does not share this information with third parties for their independent use.
After initialization, the magnes/fraudnet library will automatically send the risk payload to PayPal. For further details please read the FraudNet library documentation provided by PayPal.
The express checkout uses the complete process including generic payment requests. If you don’t want to use the complete express checkout experience, the process will start with the “place order” button.
|
add_paydata[risk_session_correlation_id]
required
|
This id is generated through FraudNet Library. Please use this parameter to send the value to PayPal for fraud prevention purposes. |