Skip to main content

Create Request

amountnumber<double>required

Payment amount. Precision must be two digits after the decimal separator.

Example: 9.99
currencystringrequired

ISO 4217 three-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

Example: EUR
customer objectrequired
idstringrequired

Value that uniquely identifies the end customer and is provided by the business partner. If personal data such as a username or email address is used, it must be encrypted or hashed for security reasons.

Example: merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation
submerchant_idstring

Reporting criterion that offers the possibility to classify sub-merchants. Agreement with paysafecard is needed; values that are not agreed lead to a failed transaction.

Example: 1
expiration_time_minutesinteger<int64>

Time frame the customer is given to go to a payment point and pay for the transaction, in minutes. The allowed span is between 1 and 1440 minutes. If no specific setting is used, the default setting of 24 hours is taken.

Example: 5
webhook_urlstring<uri>

URL to be used by paysafecard to notify upon authorization has been successfully completed.

Example: https://notification.com/
customer_takeover_data object

Customer data used to prefill the registration form in the barcode application. paysafecard does not store this data.

When KYC reliance is enabled, the document object and kyc_level are mandatory. Additional KYC fields are mandatory if available.

first_namestring

Customer first name.

Example: Max
last_namestring

Customer last name.

Example: Mustermann
date_of_birthstring<date>

Customer date of birth.

Example: 1990-12-31
address1string

Customer address line 1.

Example: Musterstrasse 2
postcodestring

Customer postal code.

Example: 1234
citystring

Customer city.

Example: Vienna
country_iso2string

ISO 3166-1 two-letter country code.

Possible values: >= 2 characters and <= 2 characters

Example: AT
phone_numberstring

Customer phone number. The international calling code must match the country.

Example: +43676123456789
emailstring

Customer email address.

Example: example@test.at
document object

KYC document details supplied with customer takeover data.

id_numberstring

Document identification number. Mandatory for KYC reliance.

Example: 8010369012345
typestring

Document type. Mandatory for KYC reliance.

Example: PASSPORT
issuing_authoritystring

Document issuing authority. Mandatory for KYC reliance if available.

Example: Passport Service Paris
date_of_issuancestring<date>

Document date of issuance. Mandatory for KYC reliance if available.

Example: 2010-12-31
date_of_expirystring<date>

Document expiry date. Mandatory for KYC reliance.

Example: 2030-12-31
kyc_levelstring

KYC level assigned to the customer. Mandatory for KYC reliance.

Example: FULL
tax_idstring

Customer tax identifier. Mandatory for KYC reliance if available.

Example: 1NTEST01SGxo9HZ
place_of_birthstring

Customer place of birth. Optional for KYC reliance.

Example: Versaille
ip_addressstring

Customer IP address. Optional for KYC reliance.

Example: 127.0.0.1
Create Request
{
  "amount": 9.99,
  "currency": "EUR",
  "customer": {
    "id": "merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation"
  },
  "submerchant_id": "1",
  "expiration_time_minutes": 5,
  "webhook_url": "https://notification.com/",
  "customer_takeover_data": {
    "first_name": "Max",
    "last_name": "Mustermann",
    "date_of_birth": "1990-12-31",
    "address1": "Musterstrasse 2",
    "postcode": "1234",
    "city": "Vienna",
    "country_iso2": "AT",
    "phone_number": "+43676123456789",
    "email": "example@test.at",
    "document": {
      "id_number": "8010369012345",
      "type": "PASSPORT",
      "issuing_authority": "Passport Service Paris",
      "date_of_issuance": "2010-12-31",
      "date_of_expiry": "2030-12-31"
    },
    "kyc_level": "FULL",
    "tax_id": "1NTEST01SGxo9HZ",
    "place_of_birth": "Versaille",
    "ip_address": "127.0.0.1"
  }
}