**Last updated**: 17 November 2025 | [**Change log**](/products/apms/changelog/)

# Get started

Make yourself familiar with our [API Principles](/products/reference/api-principles) to 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.


```
Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.pay-direct-v1+json
Accept: application/vnd.worldpay.pay-direct-v1+json
```

| Header | Description |
|  --- | --- |
| `Authorization` | We use the `Authorization` header to identify and authenticate you within Access Worldpay. You **must** use the `Authorization` header for any request you send to our APM API. |
| `Content-Type` | We require the `Content-Type` header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`. |
| `Accept` | We use the `Accept` header to identify which version of our APM 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 guides you by providing you with links to the next available actions.

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

### Request

`GET` `https://try.access.worldpay-bsh.securedataplatform.com/`

Note
No request body is needed for this request.

### Response

You receive all our available API resources in the response:

{
  "_links": {
    "payments:authorize": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations"
    },
    "service:payments": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments"
    },
    "service:sessions": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/sessions"
    },
    "service:tokens": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens"
    },
    "service:verifications/accounts": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts"
    },
    "service:verifications/customers/3ds": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/verifications/customers/3ds"
    },
    "service:verifiedTokens": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/verifiedTokens"
    },
    "service:fraudsight": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/fraudsight"
    },
    "service:exemptions": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/exemptions"
    },
    "service:payouts": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts"
    },
    "service:payments/alternative/direct": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/direct"
    },
    "service:payments/alternative/action/paypal": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/action/paypal"
    },
    "service:payments/alternative/action/ideal": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/action/ideal"
    },
    "service:payouts/accounts": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/accounts"
    },
    "service:payouts/events": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/payouts/events"
    },
    "service:moneyTransfers": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/moneyTransfers"
    },
    "service:foreignExchange": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/foreignExchange"
    },
    "service:accounts/statements": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/accounts/statements"
    },
    "service:accounts/balance": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/accounts/balance"
    },
    "service:accounts/transfer": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.com/accounts/transfer"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/{rel}",
        "name": "payments",
        "templated": true
      }
    ]
  }
}

details
summary
Action links and URI resources
When integrating into Access Worldpay, we strongly recommend that you get the URI resource links from the action links. Do not hard code the URI resource links, they could change and break your integration.

### What is an action link?

An action link is a parameter where the URI link to the resource is stored.

### What is a URI resource link?

A URI resource link is the link to the resource you send your requests to.

## Query the Paydirect root resource

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

### Request

`GET`  `https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/direct`

Note
No request body is needed for this request.

### The response


```
      {
    "_links": {
        "resourceTree": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/alternative/direct/resourceTree"
        },
        "direct:sale": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/direct/sale",
            "templated": true
        },
        "direct:events": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/alternative/direct/events",
            "templated": true
        },
        "curies": [
            {
                "name": "direct",
                "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/alternative/direct/{rel}",
                "templated": true
            }
        ]
    }
}
```

#### Resources

The response contains a link for the sale request:

| Action Link (resources) | Description |
|  --- | --- |
| direct:sale | Action link for your sale request. |
| [direct:query](/products/apms/20230601/paydirect/manage-payment#payment-query) | Payment query request |


## DNS Whitelisting

Whitelist the following URLs:

* `https://try.access.worldpay-bsh.securedataplatform.com/`
* `https://access.worldpay-bsh.securedataplatform.com/`


Please ensure you use DNS whitelisting not explicit IP whitelisting.

### Link Caching

Note
When you make a request within Access Worldpay, you should always cache the response returned.

**Next steps**

[Pay with ACH](/products/apms/20230601/paydirect/ach/sale)
[Pay with EFT](/products/apms/20230601/paydirect/eft/sale)