Last updated: 17 November 2025 | Change log
A pre-paid, cash-based online payment method.
Make yourself familiar with our API principles to ensure a resilient integration.
Product overview
| 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
| 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 |
Payments made in RON and NOK are settled in EUR. Payments made with any other acceptance currency are settled in the same currency.
Use our API reference and set your headers.
POST https://try.access.worldpay.com/apmPayments
- Tryhttps://try.access.worldpay.com/apmPayments
- Livehttps://access.worldpay.com/apmPayments
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
{ "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" } } }
A unique reference generated by you that is used to identify a payment throughout its lifecycle. Bizum specific regex [a-zA-Z0-9]{4,12}.
Used to route the request in Access Worldpay, created as part of on-boarding.
Object that contains the payment type and details.
Type of payment method
- ach
- alipay_cn
- alipay_hk
- alipay_uni
- bancontact
- bizum
- blik
- eft
- euteller
- ideal
- klarna
- konbini
- multibanco
- mybank
- open_banking
- oxxo
- paypal
- paysafecard
- pix
- przelewy
- sepa
- safetypay
- trustly
- wechatpay
The value of the payment.
The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.
The supported ISO 4217 currency codes.
The description shown on your customer's bank statement for the payment.
The type of instrument.
Account type.
Account number of direct debit account.
Routing number of direct debit account.
Check number of the direct debit account.
Company name if a corporate account.
City.
The supported ISO 3166-1 alpha-2 country codes.
Postal code.
State code of the billing address in ISO 3166-2 format.
Your customer's first name.
Your customer's last name.
Your unique reference for the customer so that the 'pay faster next time' function can be used during checkout. This allows the shoppers chosen bank to be stored for their next payment.
The customer's e-mail address.
{
"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"
}The identifier of the payment resource.
Links to resources related to the request.
The URL to redirect your customer to.
An action ID generated by us identifying a single merchant interaction
Check out our API reference for more responses or error codes.
Next steps