paysafecard for Webservices API

brand-paysafecard.jpg

  The following content assumes you have obtained the necessary PCI certification to process and submit sensitive cardholder data in the request to our Webservices API.
If you are unsure, please contact our Support Team for assistance.

A “paysafecard” is a pre-paid card that can be purchased by your customers from sales outlets worldwide (e.g. at PayPoint outlets). Each paysafecard contains a unique PIN that the customer can enter on the checkout page in order to complete a purchase.

my paysafecard” is a personal online payments account to help customers keep track of multiple paysafecard PINs. The customer can opt to sign in to their “my paysafecard” account at time of purchase, which allows them to pay with paysafecard PINs stored on their account.

  Supported customer countries   No restrictions on customer countries
  Supported currencies   ARS, AUD, BGN, CAD, CHF, CZK, DKK, EUR, GBP, HRK, HUF, MXN, NOK, NZD, PEN, PLN, RON, SEK, TRY, USD, UYU
  Refunds

  Refunds not supported.

  Chargebacks

  Payments are not subject to chargebacks.

 

Configuration

To enable paysafecard on your account, please get in touch with your account manager.
A test sandbox account will be provided, which you will need when testing your implementation.

 

Process overview

What will the customer see?

  • During the checkout process, your website presents paysafecard as a payment method.
  • The customer selects their preferred delivery address on your checkout page and opts to pay using paysafecard.
  • The customer is redirected to paysafecard, where they either enter their PIN(s), or signs into their “my paysafecard” account.
  • The customer reviews their order and agrees to the payment on paysafecard.
  • The customer is redirected to your website, where a confirmation is displayed (e.g. “Payment successful”).

paysafecard_-_Flow.svg

How does it work behind the scenes?

The paysafecard payment flow can be split into three main parts, as shown below:

 

1. Initiate the customer

paysafecard_-_Step_1.svg



2. Redirect to paysafecard

paysafecard_-_Step_2.svg



3. Processing the authorisation

paysafecard_-_Step_3.svg

 

1. Initiate the customer

When the customer chooses to pay with paysafecard, your system will need to perform an ORDER request and interpret the response returned.

 

ORDER request example

Python PHP cURL Raw JSON Raw XML
#!/usr/bin/python
import securetrading

stconfig = securetrading.Config()
stconfig.username = "webservices@example.com"
stconfig.password = "Password1^"
st = securetrading.Api(stconfig)

order = {
"currencyiso3a": "GBP",
"requesttypedescription": "ORDER",
"accounttypedescription": "ECOM",
"sitereference": "test_site12345",
"baseamount": "2001",
"paymenttypedescription": "PAYSAFECARD",
"returnurl": "https://www.example.com/return",
"cancelurl": "https://www.example.com/cancel",
"billingid": "000001",
"paysafeminage": "18",
"paysafekyclevel": "SIMPLE",
"paysafecountryrestriction": "DE"
}

strequest = securetrading.Request()
strequest.update(order)
stresponse = st.process(strequest) #stresponse contains the transaction response

Replace <DOMAIN> with a supported domain. Click here for a full list.

 

Field specification

  Field Format Description
table-required.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha (20) Only “ECOM” (e-commerce) is supported.
table-required.png baseamount
XPath: /billing/amount
Numeric (11) The amount of the transaction in base units, with no commas or decimal points, so €10 is submitted as 1000. This value must be greater than zero.
table-required.png billingid
XPath: /billing/@id
Alphanumeric (100) An id provided by you, used to identify the customer.

 You must always submit a billingid:

  • Each customer must be assigned a unique id.
  • This id must be re-used by returning customers.
table-required.png cancelurl
XPath: /merchant/cancelurl
URL (2048) The URL that the customer will be returned to if they cancel the authorisation while on paysafecard’s servers.
table-required.png currencyiso3a
XPath: /billing/amount/@currencycode
Alpha (3) The currency that the transaction will be processed in. paysafecard transactions can be processed in the following currencies:

ARS, AUD, BGN, CAD, CHF, CZK, DKK, EUR, GBP, HRK, HUF, MXN, NOK, NZD, PEN, PLN, RON, SEK, TRY, USD, UYU

Click here for further information on currency codes.

table-optional.png orderreference
XPath: /merchant/orderreference
Alphanumeric including symbols (25)

 

Recommended length 25 characters or less (exact length dependent on acquiring bank). Failure to adhere to this requirement may result in the text being truncated in the transaction.

Your unique order reference that can be stored on the Trust Payments system.
table-required.png paymenttypedescription
XPath: /billing/payment/@type
Alpha (20) This value must be submitted as “PAYSAFECARD”.
table-optional.png paysafecountryrestriction
XPath: /billing/payment/paysafe/countryrestriction
Alpha (2) Restricts the payment to be processed exclusively from the country specified (in iso2a format).

e.g. “GB” for United Kingdom.

Click here for a full list of country codes.

table-optional.png paysafekyclevel
XPath: /billing/payment/paysafe/kyclevel
Alpha (6)

Specifies the required KYC level for the “my paysafecard” account holder. There are two levels:

  • SIMPLE” – The customer has successfully completed the initial registration process and confirmed their mobile number and email address.
  • FULL” – In addition to the above, the customer has also provided proof of identification (e.g. passport, driving license) and proof of address (e.g. utility bill).
table-optional.png paysafeminage
XPath: /billing/payment/paysafe/minage
Numeric (3) Specifies the minimum age of the “my paysafecard” account holder.

e.g. To restrict to over-18s only, submit “18” in this field.

table-required.png requesttypedescription
XPath: /@type
Alpha (20) The value in the request must be “ORDER”.
table-required.png returnurl
XPath: /merchant/returnurl
URL (2048) The URL that the customer will be returned to following a successful authorisation.
table-required.png sitereference
XPath: /operation/sitereference
Alphanumeric
& underscore (50)
The site reference relates to your individual account which you received on setup. If you do not know your site reference, please contact our Support Team.

 

ORDER response example

Python PHP Raw JSON Raw XML
{
u 'requestreference': u 'A0bxh87wt',
u 'version': u '1.00',
u 'responses': [{
u 'transactionreference': u '72-32-20002',
u 'paymenttypedescription': u 'PAYSAFECARD',
u 'settleduedate': u '2016-12-23',
u 'transactionstartedtimestamp': u '2016-12-23 15:35:40',
u 'errormessage': u 'Ok',
u 'accounttypedescription': u 'ECOM',
u 'errorcode': u '0',
u 'customerredirecturl': u 'https://www.paysafecard.com/etc',
u 'requesttypedescription': u 'ORDER',
u 'settlestatus': u '0',
u 'operatorname': u 'webservices@example.com',
u 'livestatus': u '0',
u 'paysafeminage': u '18',
u 'paysafekyclevel': u 'SIMPLE',
u 'paysafecountryrestriction': u 'DE',
u 'paysafeid': u '23842'
}]
}

 

Field specification

  Field Format Description
table-returned.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha (20) The value returned is “ECOM”.
table-returned.png customerredirecturl
XPath: /customer/redirecturl
URL (500) You will need to redirect the customer’s browser to this URL to continue with the payment.
table-returned.png errorcode
XPath: /error/code
Numeric (1-5)

The error code should be used to determine if the request was successful or not.

  • If the error code is “0” then the transaction was successful.
  • If the error code is not “0” then the transaction was not successful.

Click here for a full list of errorcode and message values.

table-conditional.png errordata
XPath: /error/data
Alphanumeric (255)

Additional information to help troubleshoot the error.

Only returned if there has been an error.

table-returned.png errormessage
XPath: /error/message
Alphanumeric (255) This is the corresponding message to the above code.

Click here for a full list of errorcode and message values.

table-returned.png livestatus
XPath: /live
Numeric (1)
  • 0 – Transaction processed using a test account.
  • 1 – Transaction processed using a live account.
table-returned.png operatorname
XPath: /merchant/operatorname
Alphanumeric (255) The value of this field contains the name of the user that processed the request.
table-returned.png paymenttypedescription
XPath: /billing/payment/@type
Alpha (20) This value returned is “PAYSAFECARD”.
table-conditional.png paysafecountryrestriction
XPath: /billing/payment/paysafe/countryrestriction
Alpha (2) Restricts the payment to be processed exclusively from the country specified (in iso2a format).

e.g. “GB” for United Kingdom.

Click here for a full list of country codes.

Returned if submitted in the ORDER request.

table-returned.png paysafeid
XPath: /paysafe/@id
Alphanumeric (255) A unique id assigned to the transaction by paysafecard. You can store these ids for future correspondence with paysafecard.
table-conditional.png paysafekyclevel
XPath: /billing/payment/paysafe/kyclevel
Alpha (6)

Specifies the required KYC level for the “my paysafecard” account holder. There are two levels:

  • SIMPLE” – The customer has successfully completed the initial registration process and confirmed their mobile number and email address.
  • FULL” – In addition to the above, the customer has also provided proof of identification (e.g. passport, driving license) and proof of address (e.g. utility bill).

Returned if submitted in the ORDER request.

table-conditional.png paysafeminage
XPath: /billing/payment/paysafe/minage
Numeric (3)

The minimum age of the “my paysafecard” account holder, as specified in the ORDER request.

Returned if submitted in the ORDER request.

table-returned.png requesttypedescription
XPath: /@type
Alpha (20) The value returned is “ORDER”.
table-returned.png settleduedate
XPath: /settlement/settleduedate
Date YYYY-MM-DD The date on which the transaction will be settled.
table-returned.png settlestatus
XPath: /settlement/settlestatus
Numeric (3)
  • “0” indicates no issues have been raised so far that would prevent settlement from taking place.
  • “3” indicates the request was unsuccessful.
table-returned.png transactionreference
XPath: /transactionreference
Alphanumeric including
hyphens (25)
A unique reference for the request assigned by Trust Payments.

You will need to submit this reference in the AUTH request that follows.

table-returned.png transactionstartedtimestamp
XPath: /timestamp
Date time YYYY-MM-DD hh:mm:ss The time the request was processed.

 

2. Redirect to paysafecard

After successfully submitting an ORDER Request, your system will be returned a customerredirecturl in the response. Your system will need to redirect the customer to this URL, which is a page hosted by paysafecard, in order to process the payment.

When testing, you will be redirected to paysafecard’s sandbox page, which simulates the page that will be displayed to your customers (screenshot below).

wsapi-paysafecard-05.png

The customer will be offered the choice between either:

  • Entering the PIN found on their card (they can enter multiple PINs if needed).
  • Signing in to their “my paysafecard” account.

The customer can proceed with the payment by clicking the “Pay” button.

  If you specify certain restrictions in the ORDER Request (e.g. a minimum age requirement), the customer may be forced to sign in to their “my paysafecard” account to verify their details (e.g. to check their age). For further information, please refer to paysafecard’s own resources.

 

If successful authentication

The customer’s browser is redirected to the returnurl specified in the ORDER Request.

  The payment is not completed until you successfully process the AUTH request described below.

You must wait for the customer to return from paysafecard to the returnurl hosted on your servers before continuing.

 

If customer cancels

The customer can cancel by clicking the cross in the upper-right. This redirects the customer’s browser to the cancelurl specified in the ORDER Request. You can then provide alternative methods of payment. If the customer wants to try again with paysafecard, you must start again by submitting a new ORDER Request.

  When testing, you will be displayed the sandbox as provided by paysafecard. To complete a test transaction, you will need to follow the instructions displayed on screen. Please contact your account manager for test credentials to enter while on the sandbox.

 

3. Processing the authorisations

  If the customer is redirected to the cancelurl:

Present your customer with alternative payment methods so they can try again.

  If the customer is redirected to the returnurl:

Follow the instructions below.

 

AUTH request example

This example demonstrates how to process an AUTH request for paysafecard.

Python PHP cURL Raw JSON Raw XML
#!/usr/bin/python
import securetrading

stconfig = securetrading.Config()
stconfig.username = "webservices@example.com"
stconfig.password = "Password1^"
st = securetrading.Api(stconfig)

auth = {
"requesttypedescription": "AUTH",
"sitereference": "test_site12345",
"parenttransactionreference": "72-32-20002",
"paymenttypedescription": "PAYSAFECARD"
}

strequest = securetrading.Request()
strequest.update(auth)
stresponse = st.process(strequest) #stresponse contains the transaction response

Replace <DOMAIN> with a supported domain. Click here for a full list.

 

Field specification

  Field Format Description
table-required.png parenttransactionreference
XPath: /operation/parenttransactionreference
Alphanumeric
& hyphens (25)
In the request, submit the transactionreference of the preceding ORDER.
table-required.png paymenttypedescription
XPath: /billing/payment/@type
Alpha (20) This value must be submitted as “PAYSAFECARD”.
table-required.png requesttypedescription
XPath: /@type
Alpha (20) The value in the request must be “AUTH”.
table-required.png sitereference
XPath: /operation/sitereference
Alphanumeric
& underscore (50)
The site reference relates to your individual account which you received on setup. If you do not know your site reference, please contact our Support Team.

 

AUTH response example

Here is an example of an AUTH response for paysafecard.

Python PHP Raw JSON Raw XML
{
u 'requestreference': u 'A0dcb11e6',
u 'version': u '1.00',
u 'responses': [{
u 'transactionreference': u '72-32-20004',
u 'merchantname': u 'Test Merchant',
u 'paymenttypedescription': u 'PAYSAFECARD',
u 'transactionstartedtimestamp': u '2016-12-23 15:36:31',
u 'errormessage': u 'Ok',
u 'parenttransactionreference': u '72-32-20003',
u 'accounttypedescription': u 'ECOM',
u 'errorcode': u '0',
u 'settleduedate': u '2017-05-30',
u 'currencyiso3a': u 'GBP',
u 'baseamount': u '2001',
u 'requesttypedescription': u 'AUTH',
u 'operatorname': u 'webservices@example.com',
u 'livestatus': u '0',
u 'settlestatus': u '0',
u 'paysafeminage': u '18',
u 'paysafekyclevel': u 'SIMPLE',
u 'paysafecountryrestriction': u 'DE',
u 'paysafeid': u '23842'
}]
}

 

Field specification

  Field Format Description
table-returned.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha (20) The value returned is “ECOM”.
table-returned.png baseamount
XPath: /billing/amount
Numeric (11) The amount of the transaction in base units, with no commas or decimal points, so €10 is returned as 1000.
table-returned.png currencyiso3a
XPath: /billing/amount/@currencycode
Alpha (3) The currency that the transaction was processed in (in ISO3A format).
table-returned.png errorcode
XPath: /error/code
Numeric (1-5) The error code should be used to determine if the request was successful or not.
  • If the error code is “0” then the transaction was successful.
  • If the error code is not “0” then the transaction was not successful.

Click here for a full list of errorcode and message values.

table-conditional.png errordata
XPath: /error/data
Alphanumeric (255)

Additional information to help troubleshoot the error.

Only returned if there has been an error.

table-returned.png errormessage
XPath: /error/message
Alphanumeric (255) This is the corresponding message to the above code.

Click here for a full list of errorcode and message values.

table-returned.png livestatus
XPath: /live
Numeric (1)
  • 0 – Transaction processed using a test account.
  • 1 – Transaction processed using a live account.
table-conditional.png merchantname
XPath: /merchant/merchantname
Alphanumeric (255) These are details associated with the account used to process the transaction.

To amend these fields, please contact our Support Team.

Depends on your account configuration.

table-returned.png operatorname
XPath: /merchant/operatorname
Alphanumeric (255) The value of this field contains the name of the user that processed the request.
table-returned.png parenttransactionreference
XPath: /operation/parenttransactionreference
Alphanumeric
& hyphens (25)
The transactionreference of the preceding ORDER.
table-returned.png paymenttypedescription
XPath: /billing/payment/@type
Alpha (20) This value returned is “PAYSAFECARD”.
table-conditional.png paysafecountryrestriction
XPath: /billing/payment/paysafe/countryrestriction
Alpha (2) Restricts the payment to be processed exclusively from the country specified (in iso2a format).

e.g. “GB” for United Kingdom.

Click here for a full list of country codes.

Returned if submitted in the ORDER request.

table-returned.png paysafeid
XPath: /paysafe/@id
Alphanumeric (255) A unique id assigned to the transaction by paysafecard. You can store these ids for future correspondence with paysafecard.
table-conditional.png paysafekyclevel
XPath: /billing/payment/paysafe/kyclevel
Alpha (6)

Specifies the required KYC level for the “my paysafecard” account holder. There are two levels:

  • SIMPLE” – The customer has successfully completed the initial registration process and confirmed their mobile number and email address.
  • FULL” – In addition to the above, the customer has also provided proof of identification (e.g. passport, driving license) and proof of address (e.g. utility bill).

Returned if submitted in the ORDER request.

table-conditional.png paysafeminage
XPath: /billing/payment/paysafe/minage
Numeric (3)

The minimum age of the “my paysafecard” account holder, as specified in the ORDER request.

Returned if submitted in the ORDER request.

table-returned.png requesttypedescription
XPath: /@type
Alpha (20) The value returned is “AUTH”.
table-returned.png settleduedate
XPath: /settlement/settleduedate
Date YYYY-MM-DD The date on which the transaction will be settled.
table-returned.png settlestatus
XPath: /settlement/settlestatus
Numeric (3)
  • “100” indicates funds will be captured immediately.
  • “3” indicates the request was unsuccessful.
table-returned.png transactionreference
XPath: /transactionreference
Alphanumeric including
hyphens (25)
A unique reference for the transaction assigned by Trust Payments.
table-returned.png transactionstartedtimestamp
XPath: /timestamp
Date time YYYY-MM-DD hh:mm:ss The time the transaction was processed.

 

Notifications

Before you begin testing, we recommend that you contact our Support Team and request that rules are enabled on your account, which submit URL notifications to your system when a payment has been authorised.

 

Configuring the notification

We recommend including at least the following fields in URL notifications sent on authorisation:

  • Base Amount (baseamount) (e.g. £10.50 is “1050”)*
  • Main Amount (mainamount) (e.g. £10.50 is “10.50”)*
  • Billing Country (billingcountryiso2a)
  • Currency (currencyiso3a)
  • Error Code (errorcode)
  • Live Status (livestatus)
  • Order Reference (orderreference)
  • Payment Type (paymenttypedescription)
  • Request Type (requesttypedescription)
  • Settle Status (settlestatus)
  • Site Reference (sitereference)
  • Transaction Reference (transactionreference)
  • Transaction Started Timestamp (transactionstartedtimestamp)

*Please choose your preferred format.

 

Check the notification

You will need to check the contents of each notification received and respond accordingly by following the processes outlined in our URL notifications documentation. In particular, you will need to look at the settlestatus value:

  • If the settlestatus is “100”, this indicates the payment has been authorised and the funds have been settled into your account.
  • Alternatively, if the settlestatus is “3”, this indicates an error occurred and the payment was cancelled. You can use the errorcode to determine the cause of the error.

 

Settlement

Provided the requests were successful, the funds are settled immediately after the customer has completed the payment. You will not be able to cancel or otherwise update paysafecard transactions after you have submitted the AUTH request.

 

Additional notes

Fraud-prevention

Fraud and duplicate checks

Fraud and duplicate checks are not performed on paysafecard transactions.

 

Address Verification Service (AVS) checks

AVS checks cannot be performed on paysafecard transactions.

 

Frozen cards

At the customer’s request, paysafecards can be “frozen”, to prevent all further purchases. Click here for further information.

 

If the customer fails to enter their PIN

After performing the ORDER request and receiving a successful response, the customer will have 30 minutes to enter their payment details on paysafecard’s website, after which the payment will be flagged as “expired” by paysafecard, and the customer will need to start again with a new ORDER.

 

Account type

Only “ECOM” (e-commerce) is supported as the account type for paysafecard transactions. The customer must be present at time-of-purchase to enter their PIN, or to sign in to their account.

 

iframes

The paysafecard-hosted page can be hosted in an iframe.

Always allow vertical scrolling or dynamic sizing. Maximum height of 840px.

paysafecard’s payment page is optimised automatically for mobile devices.

If a customer is using a device with a resolution with width smaller than 600px, a payment panel optimised for mobile devices will be automatically shown. This is also the case if the embedded iframe has a smaller width than 600px.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request