Skip to main content

SafetyPay Payment Response

objectstring
Example: PAYMENT
idstring

Unique payment identifier.

Example: pay_1100000000_v2Pa0tDn0tr1CpvkSQoyjY77eV005P1_USD
createdinteger<int64>

Payment creation timestamp.

Example: 1607074107062
updatedinteger<int64>

Payment update timestamp.

Example: 1607074107062
currencystring
Example: USD
statusstring
Example: INITIATED
typestring
Example: PAYSAFECARD
redirect object
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
customer object
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
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"]
amountnumber<double>
Example: 1
notification_urlstring<uri>
Example: https://notification.example.com/payment
SafetyPay Payment Response
{
  "object": "PAYMENT",
  "id": "pay_1100000000_v2Pa0tDn0tr1CpvkSQoyjY77eV005P1_USD",
  "created": 1607074107062,
  "updated": 1607074107062,
  "currency": "USD",
  "status": "INITIATED",
  "type": "PAYSAFECARD",
  "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"
  },
  "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"
  },
  "restrictions": {
    "payment_instrument": "safetypay",
    "payment_instrument_subtype": "online",
    "bank_ids": [
      "8439",
      "8382"
    ]
  },
  "amount": 1,
  "notification_url": "https://notification.example.com/payment"
}