Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.
Access Worldpay
/
Access APMs: API Reference

Access APMs: API Reference (2023-06-01)

API for creating and managing APM payments on Access Worldpay.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Try
https://try.access.worldpay.com/
Live
https://access.worldpay.com/

Create an APM payment

Request

Perform a sale.

Headers
Content-Typestringrequired

The content type of the request body

Value"application/json"
WP-Api-Versionstringrequired

The API version

Value"2023-06-01"
Bodyapplication/jsonrequired
instructionobjectrequired
narrativeobjectrequired

Details about the payment.

line1string[ 0 .. 24 ] characters^[a-zA-Z0-9\-\.\,\ ]*$required

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

Example:

"Joe Plumbing Ltd"

paymentInstrumentobjectrequired

The instrument used to take the payment

typestringrequired

The type of instrument.

Value"alipay"
Discriminator
cancelURLstringrequired

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

Example:

"https://worldpay.com/cancel"

countrystringrequired

Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.

Enum"AD""AE""AF""AG""AI""AL""AM""AN""AO""AQ"
Example:

"GB"

pendingURLstringrequired

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

Example:

"https://worldpay.com/pending"

shopperEmailAddressstringrequired

Your customer's e-mail address.

Example:

"shopper@worldpay.com"

successURLstringrequired

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

Example:

"https://worldpay.com/success"

valueobjectrequired

The value of the payment.

amountinteger(int64)>= 1required

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

Example:

1234

currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"
merchantobjectrequired
entitystring[ 0 .. 32 ] characters^([a-zA-Z0-9]*)$required

The Access Entity entityReference.

Example:

"MindPalaceLtd"

transactionReferencestring[ 0 .. 64 ] characters^[a-zA-Z0-9\-\_\/\!\@\#\$\%\(\)\*\=\.\:\;\?\[...required
application/json
{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "narrative": {
      "line1": "MindPalace"
    },
    "value": {
      "amount": 35,
      "currency": "GBP"
    },
    "paymentInstrument": {
      "type": "paypal",
      "requestAutoSettlement": {
        "enabled": true
      },
      "shopperEmailAddress": "shopper@example.com",
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      },
      "shippingAddress": {
        "address1": "The Palatine Centre",
        "postalCode": "DH1 3LE",
        "city": "Durham",
        "state": "County Durham",
        "countryCode": "GB"
      },
      "successURL": "https://example.com/success",
      "pendingURL": "https://example.com/pending",
      "failureURL": "https://example.com/failure",
      "cancelURL": "https://example.com/cancel"
    }
  }
}

Responses

Request successful

Bodyapplication/json
One of:

A payment resource.

_actionsobject

Actions that can be performed on the payment resource. These are dynamic based on factors such as the payment instrument and state of the payment.

partialReverseobject

The URL you can invoke to partially reverse the payment. Make sure to check it's present, not always present.

hrefstring
reverseobject

The URL you can invoke to reverse the payment. Make sure to check it's present, not always present.

hrefstring
settleobject

The URL you can invoke to settle the payment. Make sure to check it's present, not always present.

hrefstring
_linksobject

Links to resources related to the request.

selfobject

The URL you can invoke to fetch the last event for the payment.

hrefstring
lastEventstring
Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""settlementFailed""chargebackReversed""chargedBack""disputeExpired""disputeFundsHeld"
paymentIdstring

The identifier of the payment resource.

Response
application/json
{
  "paymentId": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
  "lastEvent": "pending",
  "url": "https://mock.hpp.worldpay.com/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
    }
  },
  "_actions": {}
}

Operational

Operations

Payment Lifecycle

Operations