Last Updated: 13 November 2024 | Change Log

paysafecard

A pre-paid, cash-based online payment method.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product Overview

Why use paysafecard?

Paysafecard is represented in 60 countries worldwide.

It uses vouchers with a 16-digit PIN code. Your customer can use these vouchers to fund online transactions without a bank account, credit card, or other personal information.

Feature summary

Payment type	Country	Reccuring	Reversals	Partial Reversals	Dispute
pre-paid	Austria, Belgium, Cyprus, Czech Republic, Denmark, France, Germany, Greece, Ireland, Italy, Liechtenstein, Luxembourg, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, Switzerland, United Kingdom	❌	❌	❌	❌

Minimum Transaction Value: 1.00 GBP
Maximum Transaction Value: 1.000 EUR

Acceptance currencies

Currency	Currency Codes
Swiss Franc	CHF
Czech Koruna	CZK
Danish Krone	DKK
Euro	EUR
Romanian Leu	RON
Pound Sterling	GBP
Norwegian Krone	NOK
Polish złoty	PLN
Swedish Krona	SEK
US dollar	USD

Note

Payments made in RON and NOK are settled in EUR. Payments made with any other acceptance currency are settled in the same currency.

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Authorization: {your_credentials}
Content-Type: application/json
WP-Api-Version: 2023-06-01

Header	Description
`Authorization`	We use the `Authorization` header to identify and authenticate you within Access Worldpay. You -must- use the `Authorization` header for any request you send to our APM API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide on Authenticating with SSL/TLS.
`Content-Type`	We require the `Content-Type` header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.
`WP-Api-Version`	We use the `WP-Api-Version` header to identify which version of our APM API you are using. You must use the `WP-Api-Version` header for any request you send to our API.

If you're using both the Content-Type and WP-Api-Version headers, they must match.

Note

Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Take a payment

POST https://try.access.worldpay.com/apmPayments

Example request

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant":
    {
        "entity": "default"
    },
    "instruction":
    {
        "narrative":
        {
            "line1": "Mind Palace Ltd"
        },
        "value":
        {
            "amount": 1234,
            "currency": "GBP"
        },
        "paymentInstrument":
        {
            "type": "paysafecard",
            "country": "GB",
            "shopperEmailAddress": "example@gmail.com",
            "successURL": "http://httpbin.org/anything/success",
            "pendingURL": "http://httpbin.org/anything/pending",
            "cancelURL": "http://httpbin.org/anything/cancel"
        }
    }
}

Parameters

Parameter	Required?	Description	Data type	Length
`transactionReference`	✅	A unique reference generated by you that is used to identify a payment throughout its lifecycle. See transaction reference format.	String	Must be between 1 to 64 characters.
`merchant`	✅	An object that contains information about the merchant.	Object	N/A
`merchant.entity`	✅	Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for Authentication and Queries. Contact your Implementation Manager for more details.	String	Must be between 1 and 32 characters.
`instruction`	✅	An object that contains all the information related to the payment.	Object	N/A
`instruction.narrative`	✅	An object that helps your customers better identify you on their statement.	Object	See our formatting rules
`instruction.narrative.line1`	✅	The first line of the narrative which appears on your customer's statement (If a character is not supported it is replaced with a space.). See narrative `line1` format for more details.	Object	24
`instruction.value`	✅	An object that contains information about the payment transaction.	Object	N/A
`instruction.value.amount`	✅	The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2,50. You can find the relevant exponent in our currency table.	Integer	N/A
`instruction.value.currency`	✅	The payment currency. Refer to the individual APM page for supported currencies.	Integer	3
`instruction.paymentInstrument`	✅	An object that contains information about the payment method.	Object	N/A
`instruction.paymentInstrument.type`	✅	The payment type and details. It defines which alternative payment method you wish to use. Value is "paysafecard".	Object	N/A
`paymentInstrument.country`	✅	The country of your customer. Follows alpha 2 ISO 3166-1 standard.	Object	2
`paymentInstrument.shopperEmailAddress`	✅	The email address of your customer.	String	N/A
`instruction.paymentInstrument.cancelURL`	✅	When your customer cancels a transaction, we redirect your customer to that cancel URL.	String	N/A
`instruction.paymentInstrument.pendingURL`	✅	When we receive the payment result for a pending payment transaction, we redirect your customer to that pending URL.	String	N/A
`instruction.paymentInstrument.successURL`	✅	When we receive the payment result for a successful payment, we redirect your customer to that success URL.	String	N/A

Response

Successful request response

an HTTP code 201
an id which is unique to the payment - we recommend storing the "id" as this can be used to manage the payment later
a url to redirect your customer to the APM provider to complete the payment
a link to query the payment status

Example Response

{
    "paymentId": "nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc",
    "lastEvent": "pending",
    "_links": {
        "self": {
            "href": "https://access.worldpay.com/apmPayments/nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc"
        }
    },
    "_actions": {},
    "url": "https://payments.worldpay.com/app/hpp/integration/wpg/corporate?OrderKey="
}

Note

In case of an error, you can get further information in our error reference.

Next Steps

Manage your paysafecard payment

paysafecard

Why use paysafecard?

Feature summary

Acceptance currencies

Set your headers

Take a payment

Example request

Parameters

Response

Successful request response

Example Response

Do you like our page?