Last Updated: 09 July 2025 | 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

Feature summary

Payment type	Country	Recurring	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.

Get Started

Get started using our API Reference and set your headers.

Request

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

Example request

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "paysafecard",
    "value": {
      "amount": 25,
      "currency": "GBP"
    },
    "narrative": {
      "line1": "Mind Palace"
    },
    "paymentInstrument": {
      "type": "direct",
      "country": "GB"
    },
    "resultUrls": {
      "pending": "https://worldpay.com/pending",
      "success": "https://worldpay.com/success",
      "cancel": "https://worldpay.com/cancel"
    },
    "customer": {
      "email": "shopper@worldpay.com"
    }
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

merchantobject(MerchantV2)required

merchant.entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.methodstringrequired

Type of payment method

Value"alipay_cn"

Discriminator

instruction.valueobject(Value)required

The value of the payment.

instruction.value.amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"

instruction.narrativeobject(NarrativeBase)required

instruction.narrative.line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"

instruction.paymentInstrumentobject(AlipayCnInstrumentV2)required

instruction.paymentInstrument.typestringrequired

Type of instruction

Value"direct"

instruction.paymentInstrument.languagestring

Your customer's language.

Enum"aa""ab""ae""af""ak""am""an""ar""as""av"

instruction.resultUrlsobject(ResultUrlsAlipay)required

instruction.resultUrls.cancelstring

The URL your customer is redirected to, after a cancelled payment outcome.

Example: "https://worldpay.com/cancel"

instruction.resultUrls.failurestringrequired

The URL your customer is redirected to, after a failed payment outcome.

Example: "https://worldpay.com/failure"

instruction.resultUrls.pendingstringrequired

The URL your customer is redirected to, after a pending payment outcome.

Example: "https://worldpay.com/pending"

instruction.resultUrls.successstringrequired

The URL your customer is redirected to, after a successful payment outcome.

Example: "https://worldpay.com/success"

instruction.deviceDataobject(DeviceData)

instruction.customerobject(CustomerWithName)

Response

Successful request response

an HTTP code 201
a paymentId which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
a redirect to redirect your customer to the APM provider to complete the payment
an link to query the payment status
an object which will give flow information such as method (e.g. paysafecard) and type (direct)
a commandId generated by us identifying a single merchant interaction (e.g. cmdYNdIHBPJwbkjLiykzTx0)

Example Response

{
    "paymentInstrument": {
        "method": "paysafecard",
        "type": "direct"
    },
    "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTy3YhKhjHb7eU81eSTnCsB+em66NOYspir3PJsMwGsI7DgQG6H8RA6ud004Gi7UbmmWuCYako2x2qLNAoCkV0HeDe9tVGUUJ8RPRm2jMHH20eHV:lzKfpwhCpCj20XtN:CPsSI2e:sopgZlkbmyvzDIeWSIThE3J1pPGsapqefRFo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3Fvy7rdfTE9SB:F5xmui5ij57ItzoUGQqmhdlJEFtZOvawnk19rQ8+2IHhZzeukzTZ41bET6DfydrjX20ywVxbq2Jw==",
    "lastEvent": "pending",
    "_links": {
        "self": {
            "href": "https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTy3YhKhjHb7eU81eSTnCsB+em66NOYspir3PJsMwGsI7DgQG6H8RA6ud004Gi7UbmmWuCYako2x2qLNAoCkV0HeDe9tVGUUJ8RPRm2jMHH20eHV:lzKfpwhCpCj20XtN:CPsSI2e:sopgZlkbmyvzDIeWSIThE3J1pPGsapqefRFo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3Fvy7rdfTE9SB:F5xmui5ij57ItzoUGQqmhdlJEFtZOvawnk19rQ8+2IHhZzeukzTZ41bET6DfydrjX20ywVxbq2Jw=="
        }
    },
    "_actions": { },
    "redirect": "http://secure-test.worldpay.com/redirect?tokenId=dc9c308b-d56b-4823-968e-0f94b20d6b73",
    "commandId": "cmdOl8x_MaK4TxcF3exdl5cL0"
}

Errors

Check out our API reference for the full error code schema.

Next Steps

Manage your Paysafecard payment