Access Worldpay
/
Access APMs: API Reference

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

Download OpenAPI specification:Download

API for creating and managing APM payments on Access Worldpay.

Servers

Try

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

Live

https://access.worldpay.com/

Create an APM payment

Perform a sale.

SecurityHTTP: BasicAuth
Request
header Parameters
Content-Type
required
string

The content type of the request body

Value: "application/json"
WP-Api-Version
required
string

The API version

Value: "2023-06-01"
Request Body schema: application/json
required
required
object (Instruction)
required
object (Merchant)
transactionReference
required
string [ 0 .. 64 ] characters ^[a-zA-Z0-9\-\_\/\!\@\#\$\%\(\)\*\=\.\:\;\?\[...
post
/apmPayments
Request samples
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

201

Request successful

400

Bad request.

401

Client is not authorized due to missing or invalid Authorization header.

415

Invalid content-type HTTP header.

500

A problem occurred processing the request on our side.

Response samples
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

Used to check whether the service is up

SecurityHTTP: BasicAuth
get
/apmPayments/status
Request samples
Responses
200
The status of the service is OK
Response Schema: */*
string 
 
Response samples
*/*
OK - 2022-05-16T10:50:55.444486
Payment Lifecycle
Get the last event for an APM payment.
Lookup the state of a payment, including the available action that can be performed.
SecurityHTTP: BasicAuth
Request
path Parameters
paymentId
required
string 
The identifier of the payment resource.
 
header Parameters
WP-Api-Version
required
string 
The API version
 Value: "2023-06-01"  
get
/apmPayments/{paymentId}
Request samples
Responses
200
Request successful
Response Schema: application/json
object (Actions)  
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.
 
object (Links)  
Links to resources related to the request.
 
lastEvent
string 
 Enum: "authorized" "cancelFailed" "cancelled" "cancelRequested" "sentForSettlement" "settlementFailed" "chargebackReversed" "chargedBack" "disputeExpired" "disputeFundsHeld" "disputeFundsReleased" "disputeReserveReleased" "error" "expired" "disputeInformationRequested" "disputInformationSupplied" "miscellaneous" "pending" "refunded" "refundExpired" "refundFailed" "refundReversed" "refused" "refusedByIssuer" "sentForRefund" "settled" "settlementReversed" "cancelledByCustomer" "signedFormReceived" "unknown" "manuallyAmended"  
paymentId
string 
The identifier of the payment resource.
 
400
Bad request.
401
Client is not authorized due to missing or invalid Authorization header.
404
Payment resource not found.
415
Invalid content-type HTTP header.
500
A problem occurred processing the request on our side.
Response samples
application/json
{
"paymentId": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
"lastEvent": "authorized",
"_links": {
"self": {
"href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
}
},
"_actions": {
"reverse": {
"href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"
},
"partialReverse": {
"href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"
}
}
}
Reverse an APM payment.
Perform a reversal on the funds taken from a sale.
SecurityHTTP: BasicAuth
Request
path Parameters
paymentId
required
string 
The identifier of the payment resource.
 
header Parameters
Content-Type
required
string 
The content type of the request body
 Value: "application/json"  
WP-Api-Version
required
string 
The API version
 Value: "2023-06-01"  
Request Body schema: application/json
required
One of:
Full reversal request (no body)
object (Full_reversal)  
 
post
/apmPayments/{paymentId}/reversals
Request samples
application/json
{ }
Responses
202
Request successful
400
Bad request.
401
Client is not authorized due to missing or invalid Authorization header.
404
Payment resource not found.
500
A problem occurred processing the request on our side.
Response samples
application/json
{
"id": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
"lastEvent": "sentForRefund",
"_links": {
"self": {
"href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
}
},
"_actions": { }
}
Settle an APM payment.
Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment.
SecurityHTTP: BasicAuth
Request
path Parameters
paymentId
required
string 
The identifier of the payment resource.
 
header Parameters
Content-Type
required
string 
The content type of the request body
 Value: "application/json"  
WP-Api-Version
required
string 
The API version
 Value: "2023-06-01"  
Request Body schema: application/json
required
One of:
Full settlement request (no body)
object (Full_settlement)  
 
post
/apmPayments/{paymentId}/settlements
Request samples
application/json
null
Responses
202
Request successful
400
Bad request.
401
Client is not authorized due to missing or invalid Authorization header.
404
Payment resource not found.
500
A problem occurred processing the request on our side.
Response samples
application/json
{
"id": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
"lastEvent": "sentForSettlement",
"_links": {
"self": {
"href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
}
},
"_actions": { }
}