Skip to main content

Technical Integration

About the API​

PaysafeCash POS cashout follows REST design principles. Requests use HTTP Basic Authentication, JSON, and standard HTTP verbs.

Versioning​

Every time there is a backwards-incompatible change to the API, a new major version is released. This major version is part of the URL path. The current major version is v1.

Establishing a connection​

A connection to the PaysafeCash system is successful if the following prerequisites are fulfilled:

  • API key for request authentication provided by PaysafeCard.
  • Authorization of the server IP address in the production environment (if a 403 error is received when trying to access the service, it is likely that the IP address is not yet allowed to access).
  • Content-type: Content-Type: application/json
  • Character encoding needs to be in UTF-8

Connect to PaysafeCard services only via the respective FQDNs. Do not cache DNS resolutions of PaysafeCard FQDNs beyond the DNS TTL. If the application is based on Java, set networkaddress.cache.ttl=60. For any other framework that caches DNS resolution, set the DNS TTL to no more than 60 seconds or rely on the TTL set by PaysafeCard DNS records.

API key authentication​

Every request to the PaysafeCard API is authenticated using an API key.

  • The value of the API key needs to be base64 encoded when transmitted in the HTTP header.
  • Set the key as the username using HTTP basic authentication.
  • The API key may only be used from backend systems.
  • The API key must be kept secured and must never be exposed.
Authorization: Basic cHNjXzYydXdPYkJnRkxn000XeXZwSlMtNE9weXRtUS1XN3Y=

Test environment and endpoints​

Every new business partner needs to first integrate the API in the test environment. Once the integration is finished, a UAT needs to be done.

EnvironmentEndpoint
Testhttps://apitest.paysafecard.com/v1/cashouts/
Productionhttps://api.paysafecard.com/v1/cashouts/

Interface guidelines​

PaysafeCash must be implemented according to the interface guidelines MSC (downloadable from paysafecash.com/business/downloads) and the instructions in this technical integration document.

Backend integration vs barcode application integration​

There are two different types of PaysafeCash POS cashout integrations available.

Important: The type of integration is agreed between the business partner and PaysafeCard and defined in the contract. The business partner cannot change the integration type at any time without first consulting PaysafeCard.

Backend integration​

The business partner retrieves the barcode using an API request and has full control on how the barcode is displayed to the customer.

Barcode application integration​

The business partner redirects the customer to the PaysafeCash barcode application. The redirection link is returned via the API request.

Desktop devices: The PaysafeCash POS cashout barcode application should be displayed as a redirect in the same window, on a new browser tab or a new browser window. Always allow vertical scrolling or dynamic sizing.

Mobile devices: The PaysafeCash POS cashout barcode application is optimized automatically for mobile devices.