Payment Request

typestringrequired

Type of the product, must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD

amountnumber<double>required

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

The current minimum amount for gift card payments is 0.10 USD and the current maximum amount is 1000.00 USD.

Example: 10

currencystringrequired

ISO 4217 - 3 letter ISO currency code.

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

Example: USD

redirect objectrequired

success_urlstringrequired

URL to redirect to after successful authorization.

The placeholder {payment_id} in the URL is replaced with the actual ID of this payment.

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

failure_urlstringrequired

URL to redirect to after the customer clicked on cancel.

The placeholder {payment_id} in the URL is replaced with the actual ID of this payment.

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

auth_urlstring<uri>

URL the customer must be redirected to in order to authorize the payment. Returned in the payment response.

Example: https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=1100000000&mtid=pay_1100000000_v2Pa0tDn0tr1CppVkSQ0yjY77eVOO5Pl_USD&amount=1.00&currency=USD

notification_urlstringrequired

Notification URL paysafecard will contact after the authorization has been successfully completed.

The placeholder {payment_id} in the URL is replaced with the actual ID of this payment.

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

customer objectrequired

idstringrequired

Uniquely identifies the customer and is provided by the merchant.

If any personal data, e.g. the customer's user name or email address, is used here, it has to be encrypted or hashed for security reasons.

Example: merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation

min_ageinteger

Valid for my paysafecard payments. Restricts payments to my paysafecard customers only, who are equal to or older than the specified age.

Please note: this means that it is required that the customer has a registered my paysafecard account to make the payment.

Example: 18

kyc_levelstring

Refers to the KYC level of the customer's my paysafecard account.

Depending on the country, my paysafecard accounts are offered with SIMPLE and/or FULL customer identification.

Possible values: [SIMPLE, FULL]

Example: SIMPLE

country_restrictionstring

ISO 3166-1 alpha-2 two-letter country code used to restrict payments to residents of a particular country.

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

Example: AT

restrictions object

The payment restrictions array. Gives the possibility to initiate a payment for the specific option chosen by the customer at the merchant's checkout.

payment_instrumentstring

The payment instrument gives the possibility to initiate the payment for the specific option chosen at the checkout page.

Possible values: [paysafecard, giftcard]

Example: giftcard

payment_instrument_subtypestring

If giftcard was used for the payment_instrument, the payment can be initiated for a specific gift card option by defining a subtype.

Possible values: [cvspharmacy, dollargeneral, openbuckscard]

Example: openbuckscard

submerchant_idstring

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

Agreement with paysafecard is needed. Values that have not been agreed lead to a failed payment. Max. 8 digits in alphanumeric code.

Possible values: <= 8 characters

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

Payment Request

{
  "type": "PAYSAFECARD",
  "amount": 10,
  "currency": "USD",
  "redirect": {
    "success_url": "https://notification.com/{payment_id}",
    "failure_url": "https://notification.com/{payment_id}",
    "auth_url": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=1100000000&mtid=pay_1100000000_v2Pa0tDn0tr1CppVkSQ0yjY77eVOO5Pl_USD&amount=1.00&currency=USD"
  },
  "notification_url": "https://notification.com/{payment_id}",
  "customer": {
    "id": "merchantclientid5HzDvoZSodKDJ7X7VQKrtestAutomation",
    "min_age": 18,
    "kyc_level": "SIMPLE",
    "country_restriction": "AT"
  },
  "restrictions": {
    "payment_instrument": "giftcard",
    "payment_instrument_subtype": "openbuckscard"
  },
  "submerchant_id": "1",
  "shop_id": "shop1"
}