New API Version | Last Updated: 27 June 2024 | Change Log

Get started with our Verifications API

Make yourself familiar with our API Principles to ensure a resilient integration.


Enable Verifications

Ask your Relationship Manager to enable Verifications during boarding.

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-v5+json,
Accept : application/vnd.worldpay.verifications.accounts-v5+json
HeaderDescription
AuthorizationWe 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 Verifications API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide on Authenticating with SSL/TLS.
Content-TypeWe require the Content-Type header for all requests sent to our Verifications API.
AcceptWe use the Accept header 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.

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

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. 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.

{
  "_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
      }
    ]
  }
}
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.

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

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

Query verifications root resource

Query the service:verifications/accounts 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:recurring": {
      "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/recurring",
      "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:dynamicRecurring": {
      "href": "https://try.access.worldpay.com/verifications/accounts/dynamic/recurring",
      "templated": true
    },
    "verifications:verification": {
      "href": "https://try.access.worldpay.com/verifications/accounts/{resource}",
      "templated": true
    },
    "verifications:ach": {
      "href": "https://try.access.worldpay.com/verifications/accounts/ach",
      "templated": true
    },
    "curies": [
      {
        "name": "verifications",
        "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
        "templated": true
      }
    ]
  }
}

Choose one of the action links and send your request to the corresponding resource.

Resources

ResourcesDescription
verifications:oneTimeVerify a oneTime payment.
verifications:cardOnFileVerify a cardOnFile payment.
verifications:recurringDo not use.
verifications:dynamicOneTimeVerify your customer's oneTime payment against a specified amount.
verifications:dynamicCardOnFileVerify your customer's cardOnFile payment against a specified amount.
verifications:dynamicRecurringDo not use.
verifications:verificationSend a request to receive the result of a historic verification.
verifications:achVerify a US bank account payment.

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.

Note

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

Next Steps


Verify a customer's account