APM API (2024-07-01)

Authentication Set your headers

    Authorization: {your_credentials}
    Content-Type: application/json
    WP-Api-Version: 2024-07-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Account APIs, unless you are using client certificate authenticating with SSL/TLS.

DNS Whitelisting

Whitelist the following URLs:

https://try.access.worldpay.com/
https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

License Worldpay

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"2024-07-01"

Bodyapplication/jsonrequired

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

merchantobjectrequired

entitystring[ 1 .. 32 ] characters^([a-zA-Z0-9]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobjectrequired

Object that contains the payment type and details.

methodstringrequired

Identifies the type of payment. More payment types are available on version 2023-06-01.

Value"paypal"

Discriminator

valueobjectrequired

The value of the payment.

narrativeobjectrequired

paymentInstrumentobjectrequired

settlementobject

Indicates whether the transaction should be sent for settlement now = true, or later = false at a time of your choosing.

resultUrlsobject

shippingobject

customerobject

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "paypal",
    "value": {
      "amount": 35,
      "currency": "GBP"
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "paymentInstrument": {
      "type": "direct",
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      }
    },
    "settlement": {
      "auto": true
    },
    "resultUrls": {
      "cancel": "https://example.com/cancel",
      "failure": "https://example.com/failure",
      "pending": "https://example.com/pending",
      "success": "https://example.com/success"
    },
    "shipping": {
      "firstName": "James",
      "lastName": "Moriarty",
      "address": {
        "address1": "The Palatine Centre",
        "postalCode": "DH1 3LE",
        "city": "Durham",
        "state": "County Durham",
        "countryCode": "GB"
      }
    },
    "customer": {
      "email": "moriarty@example.com"
    }
  }
}

Responses

Request successful

Bodyapplication/json

paymentIdstring

The identifier of the payment resource.

lastEventstring

Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"

_linksobject

Links to resources related to the request.

selfobject

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

_actionsobject

reverseobject