Last Updated: 09 July 2025 | Change Log
Open Banking
A secure and globally accepted bank to bank payment solution.
Make yourself familiar with our API Principles to ensure a resilient integration.
Product Overview
Feature summary
Payment type | Countries | Acceptance Currencies | Recurring | Reversals | Partial Reversals | Redirect time-out |
---|---|---|---|---|---|---|
Bank Transfer | EU UK | EUR GBP | ❌ |
|
| 30-40 mins |
Maximum Transaction Values:
The maximum amount for a single transaction depends on the currency:
- 1.000.000 GBP
- 25.000 EUR
Minimum Transaction Value: 1,00 GBP
The customer bank might impose their own limits on transactions.
Get Started
Get started using our API Reference and set your headers.
Request
POST
https://try.access.worldpay.com/apmPayments
Example requests
{ "paymentId": "HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8", "lastEvent": "pending", "_links": { "self": { "href": "https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8" } }, "_actions": {}, "redirect": "https://mock.hpp.worldpay.com/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah", "paymentInstrument": { "method": "paypal", "type": "redirect" }, "commandId": "cmdEy5vwB0krLe9eMwAcE66c0" }
Parameters
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
- paypal
- sepa
- alipay_hk
- alipay_cn
- klarna
- konbini
- wechatpay
- oxxo
- blik
- przelewy
- ideal
- bancontact
- open_banking
- paysafecard
- pix
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.
Type of instruction
Indicates whether the transaction should be sent for settlement now = true
, or later = false
at a time of your choosing.
The shipping address is required for recurring payments.
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 url to redirect your customer to the APM provider to complete the payment
- a link to query the payment status
- an object which will give flow information such as
method
(e.g.open_banking
) and type (direct
) - a
commandId
generated by us identifying a single merchant interaction (e.g.cmdYNdIHBPJwbkjLiykzTx0
)
Example Response
{
"paymentInstrument": {
"method": "open_banking",
"type": "direct"
},
"paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDhc4+SZY0AjeTYQPAyjybqxwsi0rmsit6VmM+ZZy8jdRCqzcgLWq7utrhtcbCH9pdFP7im0OhK+0dUerACka2SC4c2PEiPHDFAICQ4l1CuKJ9vs+FDuLhRUHrHK42uoIbAfefEFrfTM6o34u5XL702PNKoJbKOaHlAmYTOWTPLy1lVo+DSP:crPJz+TKxXR+Hx:8bB5kMN3qM4hu5JSRleOAV:glrYW2KYuiJVC0kexfflYxnJ7fBNd2BtiK2hD2L4o+D:vH3ePSb0IAj0UCqUUzIJ:7lB7tF7knZV0mCGSE90xbHhAtUnRf7e8yPpoBg==",
"lastEvent": "pending",
"_links": {
"self": {
"href": "http://localhost:8080/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDhc4+SZY0AjeTYQPAyjybqxwsi0rmsit6VmM+ZZy8jdRCqzcgLWq7utrhtcbCH9pdFP7im0OhK+0dUerACka2SC4c2PEiPHDFAICQ4l1CuKJ9vs+FDuLhRUHrHK42uoIbAfefEFrfTM6o34u5XL702PNKoJbKOaHlAmYTOWTPLy1lVo+DSP:crPJz+TKxXR+Hx:8bB5kMN3qM4hu5JSRleOAV:glrYW2KYuiJVC0kexfflYxnJ7fBNd2BtiK2hD2L4o+D:vH3ePSb0IAj0UCqUUzIJ:7lB7tF7knZV0mCGSE90xbHhAtUnRf7e8yPpoBg=="
}
},
"_actions": {},
"redirect": "http://merchant.fte66.test.worldpay.com:6061/redirect?tokenId=ec774cdf-d4e3-4d4d-a1be-f7c6ea9928e2",
"commandId": "cmdtacqTM9-6SZXms9z04yse0"
}
Errors
Check out our API reference for the full error code schema.