Menu

Get started

APMs v1
Last updated May 2022
Change log

Make yourself familiar with ourAPI Principlesto ensure a resilient integration.

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Copied!
Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.pay-action-v1+json
Accept: application/vnd.worldpay.pay-action-v1+json
HeaderDescription
AuthorizationThe Authorization header is used for authentication and identification of our merchants within Access Worldpay. You must use the Authorization header for any request you send to our Action to Pay API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide onAuthenticating with SSL/TLS.
Content-TypeThe Content-Type header is required if the request you're sending includes a request body, and if the HTTP method is a POST.
AcceptThe Accept header is used to identify which version of our Action to Pay API you are using. You must use the Accept header for any request you send to our API.

If you're using both the Content-Type and Accept headers, they must match.

Note: Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Query the root resource

Our APIs guide you by providing you with links to the next available actions.

To discover and start using our APIs you must first query the root resource. This returns the available resources within Access Worldpay.

Request

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

Note: No request body is needed for this request.

Response

You receive all our available API resources in the response:

Copied!
{
    "_links": {
        "payments:authorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations"
        },
        "service:payments": {
            "href": "https://try.access.worldpay.com/payments"
        },
        "service:sessions": {
            "href": "https://try.access.worldpay.com/sessions"
        },
        "service:tokens": {
            "href": "https://try.access.worldpay.com/tokens"
        },
        "service:verifications/accounts": {
            "href": "https://try.access.worldpay.com/verifications/accounts"
        },
        "service:verifications/customers/3ds": {
            "href": "https://try.access.worldpay.com/verifications/customers/3ds"
        },
        "service:verifiedTokens": {
            "href": "https://try.access.worldpay.com/verifiedTokens"
        },
        "service:fraudsight": {
            "href": "https://try.access.worldpay.com/fraudsight"
        },
        "service:exemptions": {
            "href": "https://try.access.worldpay.com/exemptions"
        },
        "service:payouts": {
            "href": "https://try.access.worldpay.com/payouts"
        },
        "service:payment_pages": {
            "href": "https://try.access.worldpay.com/payment_pages"
        },
        "service:payments/alternative/direct": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct"
        },
        "service:payments/alternative/action/paypal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
        },
        "service:payments/alternative/action/ideal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
        },
        "service:moneyTransfers": {
            "href": "https://try.access.worldpay.com/moneyTransfers"
        },
        "curies": [
            {
                "href": "https://try.access.worldpay.com/rels/payments/{rel}",
                "name": "payments",
                "templated": true
            }
        ]
    }
}

Query the iDeal root resource

Query the service:payments/alternative/action/ideal action link for the root resource.

Request

GET https://try.access.worldpay.com/payments/alternative/action/ideal

Note: No request body is needed for this request.

The response

Copied!
{
    "_links": {
        "resourceTree": {
            "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/resourceTree"
        },
         "action:sale": {
            "href": "/payments/alternative/action/ideal/sale",
            "templated": true
        },
         "action:query": {
            "href": "/payments/alternative/action/ideal/query",
            "templated": true
        }, 
         "curies": [
            {
                "name": "action",
                "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/{rel}",
                "templated": true
            }
        ]
    }
}

Resources

The response contains a link for the sale request:

Action Link (resources)Description
action:saleAction link for your sale request.
action:queryAction link to query the status of your payment.

Pay with iDEAL