Last Updated: 25 March 2024 | Change Log

Get started with our Verifications API

Warning

Verifications v1 will be deprecated on June 15, 2020 as it is no longer compliant with Visa/Mastercard mandates. You must integrate our latest version. Contact your Implementation Manager for further information.


Enabling Verifications

Ask your Relationship Manager or Implementation Manager to enable Verifications during boarding.

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.

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.

Query the root resource 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

            // Not in use
        },
        "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
        }]
    }
}

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

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

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 Verifications API.
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 or a PUT.
AcceptThe 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.

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

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:recurring": {
            "href": "https://try.access.worldpay.com/verifications/accounts/intelligent/recurring",
            "templated": true

            // Not in use
        },
        "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

ResourcesDescription
verifications:oneTimeVerify a oneTime payment.
verifications:cardOnFileVerify a cardOnFile payment.
verifications:recurringVerify a recurring payment.
verifications:verificationSend a request to receive the result of a historic verification.

Next steps


Verify a customer's account