Skip to main content

SafetyPay Payment Request

typestringrequired

Type of product. Must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD
amountnumber<double>required

Payment amount with two decimal places.

Possible values: >= 0.01

Example: 2000
currencystringrequired

Three-letter ISO 4217 currency code.

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

Example: BRL
redirect objectrequired
success_urlstring<uri>required

URL used after successful payment authorization.

Example: https://www.paysafecard.com/okURL
failure_urlstring<uri>required

URL used after unsuccessful or cancelled payment authorization.

Example: https://www.paysafecard.com/nokURL
auth_urlstring<uri>

URL to which the customer is redirected for authorization.

Example: https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet
notification_urlstring<uri>required

URL contacted after authorization has completed successfully.

If the URL contains a payment ID placeholder, the placeholder is replaced with the actual payment identifier.

Example: https://notification.com/payment_id
customer objectrequired
idstringrequired

Customer identifier on the merchant side.

Example: customer_id2
ipstring

Customer IP address returned with payment details.

Example: ***.***.***.***
customer_takeover_data object

Customer information used to simplify the payment journey and provide customer account data required for payout processing.

emailstring<email>

Customer email address.

Example: test@test.com
tax_idstring

Customer tax identifier. This can be supplied to prefill the CPF field for transactions in Brazil.

Example: 0123059433817717
tax_id_typestring

Type of tax identifier.

Example: BRA_CPF
account_registration_datestring<date>

Date on which the customer registered with the partner.

This value is mandatory when a deposit is intended to support payouts to the customer.

Example: 2018-05-03
account_KYC_levelstring

Customer KYC level with the partner.

This value is mandatory when a deposit is intended to support payouts to the customer.

Possible values: [FULL, SIMPLE]

Example: FULL
account_registration_countrystring

Country where the customer registered with the partner.

This value is mandatory when a deposit is intended to support payouts to the customer.

Example: MX
submerchant_idstring

Reporting criterion used to classify sub-merchants.

The value can contain up to eight alphanumeric characters and must be agreed with PaysafeCard.

Possible values: <= 8 characters

Example: 1
shop_idstring

Identifier of the shop originating the request.

This is commonly used by payment service providers acting as a proxy for multiple payment methods.

Example: shop1
restrictions object

Payment restrictions used to initiate a payment for the option selected by the customer at merchant checkout.

payment_instrumentstring

Payment instrument selected at merchant checkout.

This parameter is mandatory when payment_instrument_subtype is supplied.

Possible values: [paysafecard, safetypay]

Example: safetypay
payment_instrument_subtypestring

Payment instrument subtype selected at merchant checkout.

Possible values: [cash, online]

Example: online
bank_idsstring[]

Bank IDs used to restrict the bank options displayed to the customer.

Multiple bank IDs are supported. The source documentation states that no more than 74 characters, equivalent to 14 bank IDs, can be supplied.

Supplying bank_ids without payment_instrument displays the available payment methods.

Possible values: <= 14

Example: ["8439","8382"]
SafetyPay Payment Request
{
  "type": "PAYSAFECARD",
  "amount": 2000,
  "currency": "BRL",
  "redirect": {
    "success_url": "https://www.paysafecard.com/okURL",
    "failure_url": "https://www.paysafecard.com/nokURL",
    "auth_url": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet"
  },
  "notification_url": "https://notification.com/payment_id",
  "customer": {
    "id": "customer_id2",
    "ip": "***.***.***.***"
  },
  "customer_takeover_data": {
    "email": "test@test.com",
    "tax_id": "0123059433817717",
    "tax_id_type": "BRA_CPF",
    "account_registration_date": "2018-05-03",
    "account_KYC_level": "FULL",
    "account_registration_country": "MX"
  },
  "submerchant_id": "1",
  "shop_id": "shop1",
  "restrictions": {
    "payment_instrument": "safetypay",
    "payment_instrument_subtype": "online",
    "bank_ids": [
      "8439",
      "8382"
    ]
  }
}