PaysafeCash Payment Request

typestringrequired

Product type. Must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD

amountnumber<double>required

Payment amount, precision must be 2 digits after the colon.

Example: 9.99

currencystringrequired

Three-letter ISO 4217 currency code.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

Example: EUR

redirect objectrequired

success_urlstring<uri>required

URL used after successful payment completion.

Example: https://ok.com/{payment_id}

failure_urlstring<uri>required

URL used after failed or cancelled payment completion.

Example: https://nok.com/{payment_id}

auth_urlstring<uri>

URL to which the customer is redirected for authorization.

Example: https://customer.test.at.paysafecard.com/rest/payment/panel

webhook_urlstring<uri>required

Merchant endpoint that receives payment status webhooks.

Example: https://notification.com/

customer objectrequired

idstringrequired

Unique customer identifier provided by the merchant.

Example: merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation

business object

Business the payment is initiated for.

Send this object only when initiating a payment for a business or KYB SME customer. In that case the business id is mandatory.

idstringrequired

Uniquely identifies the business and is provided by the merchant.

The business must already be registered through the Business Details API.

Example: BID1234567

submerchant_idstring

Also called "reporting criteria", offers the possibility to classify sub-merchants.

Agreement with PaysafeCash is needed. Values that have not been agreed lead to a failed payment.

Example: 1

shop_idstring

Identification of the shop which is the originator of the request.

This is most likely used by payment service providers who act as a proxy for other payment methods as well.

Example: shop1

expiration_time_minutesinteger

The time frame the customer is given to go to a payment point and pay for the transaction, in minutes.

The allowed span for this parameter is between 5 and 20160 minutes. If no specific setting is used, the default time frame of 72 hours is taken.

Possible values: >= 5 and <= 20160

Example: 4320

customer_takeover_data object

Customer data sent by the merchant so that the registration form in the barcode application is prefilled.

first_name, last_name, date_of_birth, address1, postcode, city, country_iso2, phone_number and email make up the basic Customer Takeover Data feature. The merchant is obliged to obtain the customer's consent before sending them, and PaysafeCash does not store this data.

The remaining fields are the KYC and KYB reliance parameters. Send them only when the KYC reliance, KYB reliance or KYB SME reliance feature is used, in which case the basic parameters above become mandatory as well.

first_namestring

Customer first name.

Possible values: <= 80 characters

Example: Max

last_namestring

Customer last name.

Possible values: <= 80 characters

Example: Mustermann

date_of_birthstring<date>

Customer date of birth in ISO 8601 format (YYYY-MM-DD).

Example: 1990-12-31

address1string

Customer address line.

Possible values: <= 105 characters

Example: Musterstrasse 2

postcodestring

Customer postal code.

Possible values: <= 10 characters

Example: 1234

citystring

Customer city.

Possible values: <= 80 characters

Example: Vienna

country_iso2string

Two-letter ISO 3166-1 country code.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: AT

phone_numberstring

Customer phone number including international calling code.

Possible values: <= 19 characters

Example: +43676123456789

emailstring<email>

Customer email address.

Possible values: <= 80 characters

Example: example@test.at

document object

id_numberstring

Document identification number.

Possible values: <= 80 characters

Example: 8010369012345

typestring

Document type.

Possible values: [PASSPORT, ID_CARD, RESIDENCE_CARD, DRIVING_LICENSE]

Example: PASSPORT

issuing_authoritystring

Authority that issued the document.

Possible values: <= 80 characters

Example: Passport Service Paris

date_of_issuancestring<date>

Document issuance date in ISO 8601 format (YYYY-MM-DD).

Example: 2010-12-31

date_of_expirystring<date>

Document expiry date in ISO 8601 format (YYYY-MM-DD).

Example: 2030-12-31

tax_idstring

Customer tax identifier. Mandatory in Italy.

Possible values: <= 40 characters

Example: 1NTEST01SGxo9HZ

place_of_birthstring

Customer place of birth.

Possible values: <= 80 characters

Example: Versaille

kyc_levelstring

Customer KYC level.

Possible values: [SIMPLE, FULL]

Example: FULL

kyc_reliance_typestring

KYC or KYB reliance type.

Possible values: <= 21 characters, [KYC_RELIANCE, OPTIONAL_KYC_RELIANCE, KYB_RELIANCE, KYB_SME_RELIANCE]

Example: KYB_SME_RELIANCE

ip_addressstring

Customer IP address.

Possible values: <= 45 characters

Example: 127.0.0.1

geo_information object

latstring

Latitude coordinate.

Possible values: <= 8 characters

Example: 48.42111

lngstring

Longitude coordinate.

Possible values: <= 8 characters

Example: 16.21466

mccstring

Merchant category code. Required for KYB reliance flows.

Possible values: <= 4 characters

Example: 5551

PaysafeCash Payment Request

{
  "type": "PAYSAFECARD",
  "amount": 9.99,
  "currency": "EUR",
  "redirect": {
    "success_url": "https://ok.com/{payment_id}",
    "failure_url": "https://nok.com/{payment_id}",
    "auth_url": "https://customer.test.at.paysafecard.com/rest/payment/panel"
  },
  "webhook_url": "https://notification.com/",
  "customer": {
    "id": "merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation"
  },
  "business": {
    "id": "BID1234567"
  },
  "submerchant_id": "1",
  "shop_id": "shop1",
  "expiration_time_minutes": 4320,
  "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"
    },
    "tax_id": "1NTEST01SGxo9HZ",
    "place_of_birth": "Versaille",
    "kyc_level": "FULL",
    "kyc_reliance_type": "KYB_SME_RELIANCE",
    "ip_address": "127.0.0.1",
    "geo_information": {
      "lat": "48.42111",
      "lng": "16.21466"
    },
    "mcc": "5551"
  }
}