Skip to content
APIs
/
APM
/
OpenBanking

Last Updated: 09 July 2025 | Change Log

Open Banking

A secure and globally accepted bank to bank payment solution.

Note

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

Product Overview

Feature summary

Payment typeCountriesAcceptance CurrenciesRecurringReversalsPartial ReversalsRedirect time-out
Bank TransferEU
UK		EUR
GBP		❌
  • Refund - yes
  • Cancel- No
  • Partial refund - yes
  • Partial cancel- No
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 request

application/json
{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "open_banking",
    "expiryIn": 200,
    "value": {
      "amount": 2500,
      "currency": "EUR"
    },
    "narrative": {
      "line1": "Mind Palace"
    },
    "paymentInstrument": {
      "type": "direct",
      "country": "NL",
      "language": "en",
      "bankCode": "1345"
    },
    "resultUrls": {
      "pending": "https://worldpay.com/pending",
      "success": "https://worldpay.com/success",
      "cancel": "https://worldpay.com/cancel",
      "failure": "https://worldpay.com/failure"
    },
    "customer": {
      "email": "test@email.com",
      "customerId": "id1234"
    }
  }
}

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
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 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": "https://try.access.worldpay.com/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://secure-test.worldpay.com/redirect?tokenId=ec774cdf-d4e3-4d4d-a1be-f7c6ea9928e2",
    "commandId": "cmdtacqTM9-6SZXms9z04yse0"
}

Errors

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

Manage your Open Banking payment