Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later 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 APM 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.
https://try.access.worldpay.com/
https://access.worldpay.com/
Object that contains the payment type and details.
Identifies the type of payment. More payment types are available on version 2023-06-01.
Indicates whether the transaction should be sent for settlement now = true
, or later = false
at a time of your choosing.
https://try.access.worldpay.com/apmPayments
https://access.worldpay.com/apmPayments
{ "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" } } }
{ "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" }
https://try.access.worldpay.com/apmPayments/status
https://access.worldpay.com/apmPayments/status
No request payload