New API Version | Last Updated: 21 November 2024 | Change Log

Get started with our Verifications API

To verify your customer's account, you must send a verifications request to one of our supported resources.

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 can query the root resource first.

Query the root resource request

Discover our API resources by querying the root resource. Querying the root resource returns the available resources within Access Worldpay. Use the resources to send your requests depending on which of our APIs you're integrating into.

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

Note

No request body is needed for this request.

Next Steps

We have reviewed our API Principle approach and consider our resources stable and unlikely to change. This means you can skip querying the root resource for a quicker integration and POST directly to the API resource.

If you do want to discover all available resources, you can expand the below section "Query the root resource" for further steps.

Query the root resource

{
  "_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: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:payouts/accounts": {
      "href": "https://try.access.worldpay.com/payouts/accounts"
    },
    "service:payouts/events": {
      "href": "https://try.access.worldpay.com/payouts/events"
    },
    "service:moneyTransfers": {
      "href": "https://try.access.worldpay.com/moneyTransfers"
    },
    "service:foreignExchange": {
      "href": "https://try.access.worldpay.com/foreignExchange"
    },
    "service:accounts/statements": {
      "href": "https://try.access.worldpay.com/accounts/statements"
    },
    "service:accounts/balance": {
      "href": "https://try.access.worldpay.com/accounts/balance"
    },
    "service:accounts/transfer": {
      "href": "https://try.access.worldpay.com/accounts/transfer"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/payments/{rel}",
        "name": "payments",
        "templated": true
      }
    ]
  }
}

In the response are our available API resources. You must then query the resources to discover the specific API resources. The response contains links to your next available actions and the resources to send your request to.

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.verifications.accounts-v3+json,
Accept : application/vnd.worldpay.verifications.accounts-v3+json

Header	Description
`Authorization`	The `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 Verifications API.
`Content-Type`	The `Content-Type` header is required for all request sent to our Verifications API.
`Accept`	The `Accept` header is used to identify which version of our Verifications API you are using. You must use the `Accept` header for any request you send to our Verifications API.

The Content-Type and Accept headers, 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 verifications root resource

Query the verifications root resource to get the resources to our verifications API.

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

The response

{
    "_links": {
        "resourceTree": {
            "href": "https://try.access.worldpay.com/rels/verifications/accounts/resourceTree"
        },
        "verifications:oneTime": {
            "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/oneTime",
            "templated": true
        },
        "verifications:cardOnFile": {
            "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/cardOnFile",
            "templated": true
        },
        "verifications:dynamicOneTime": {
            "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/oneTime",
            "templated": true
        },
        "verifications:dynamicCardOnFile": {
            "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/cardOnFile",
            "templated": true
        },
        "verifications:verification": {
            "href": "https://try.access.worldpay.com/verifications/accounts/{resource}",
            "templated": true
        },
        "curies": [{
            "name": "verifications",
            "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
            "templated": true
        }]
    }
}

Resources

Resources	Description
`verifications:oneTime`	Verify a oneTime payment.
`verifications:cardOnFile`	Verify a cardOnFile payment.
`verifications:dynamicOneTime`	Verify your customer's oneTime payment against a specified amount.
`verifications:dynamicCardOnFile`	Verify your customer's cardOnFile payment against a specified amount.
`verifications:verification`	Send a request to receive the result of a historic verification.

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.

Link Caching

Note

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

Next Steps

Verify a customer's account

Get started with our Verifications API

Query the root resource

Next Steps

Set your headers

Query verifications root resource

The response

Resources

DNS Whitelisting

Link Caching

Do you like our page?