Last updated: 26 June 2026 | 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
Apply APM payment details directly using our APMs API, or use our Components SDK to create a session.
Collect the APM details and send an API request with these details to create a payment.
- 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", "orderReference": "apm-order-12345", "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" } } }
For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}
A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:
- the total amount for a single order is split across multiple payments
- you use a single reference for each payment in a recurring agreement or split shipment scenario
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
- bancomat
- bancontact
- bizum
- blik
- eft
- euteller
- ideal guest
- ideal recurring
- klarna
- klarna recurring
- klarna token
- konbini
- multibanco
- mybank
- open_banking
- paypal
- paysafecard
- pix
- przelewy
- sepa guest and first recurring
- sepa token
- safetypay
- satispay
- swish
- trustly
- unionpay
- wechatpay
The value of the payment.
The supported ISO 4217 currency codes.
The amount in the lowest denomination of the currency, e.g. pennies for GBP, cents for USD.
The description shown on your customer's bank statement for the payment.
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.
First line of the address.
Second line of the address.
Third line of the address.
Postal code.
City.
State code of the billing address in ISO 3166-2 format.
The supported ISO 3166-1 alpha-2 country codes.
Your customer's email address.
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 your customer's chosen bank to be stored for their next payment.
{
"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, or a QR code in Base64 to show to your customer, in order to complete the transaction.
An action ID generated by us, identifying a single merchant interaction.
Payment instrument details for the payment response.
Payment instrument for: ACH, Alipay China, Alipay Hong Kong, Alipay Plus, BANCOMAT Pay, Bancontact, Bizum, BLIK, EFT, Euteller, iDEAL guest, iDEAL recurring, Klarna, Klarna (recurring), Konbini, Multibanco, MyBank, Open Banking, PaysafeCard, Pix, Przelewy24, SafetyPay, Satispay, Swish, Trustly, China UnionPay, WeChat Pay.
For Pix payments - display to your customer for them to copy and paste in the Pix app.
For Swish payments - use this value as the {token} in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL}. This will prompt the app to open, allowing your customer to complete their payment.
Check out our API reference for more responses or error codes.
Next steps