Verifications (2)

Download OpenAPI specification:Download

TBD.

Servers

testing (try)

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

live

https://access.worldpay.com/

Root

Verifications root resource, returns links to available Account Verifications actions.

Retrieve the Verified tokens top-level collection resource.

Retrieve the Verified tokens top-level collection resource.

SecurityHTTP: BasicAuth
get
/verifications
Request samples
Responses

200

Links to next available actions.

Response Schema: application/vnd.worldpay.verifications.accounts-v2.hal+json
object (verifications_Verifications_200_response)
Response samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Retrieve the Verifications top-level collection resource.

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

Verifications

Verify tokens root resource, returns links to available verifiedTokens actions.

Verification resource retrieval.

Retrieval of a successful verification.

SecurityHTTP: BasicAuth
get
/verifications/accounts/verification
Request samples
Responses

200

Retrieval request successful

Response Schema: application/vnd.worldpay.verifications.accounts-v2.hal+json
outcome
required
string
checkedAt
required
string
Response samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Retrieval of a successful verification

{ "outcome": "verified", "checkedAt": "2018-09-01T10:37:36.923Z", "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource} " }, "curies": [ { "name": "verifications", "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}", "templated": true } ] } }

Verification

Verify tokens root resource, returns links to available verifiedTokens actions.

Verifications oneTime resource.

Successful account verification outcome.

SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verifications.accounts-v2.hal+json
required
object
currency
required
string
required
object
post
/verifications/accounts/intelligent/oneTime
Request samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Successful account verification outcome.

"{\"currency\": \"EUR\",\"paymentInstrument\": {\"type\": \"card/plain\",\"cardHolderName\": \"Joe Bloggs\",\"cardExpiryDate\": {\"month\": 1,\"year\": 2019},\"cardNumber\": \"4444333322221111\",\"verificationAddress\": { \"address1\": \"address1\",\"address2\": \"address2\",\"address3\": \"address3\",\"postalCode\": \"postalCode\",\"city\": \"city\",\"state\": \"state\",\"countryCode\": \"GB\"},\"cvc\": \"101\"},\"merchant\": {\"entity\": \"default\"}}"
Responses

201

The account verification has been successful.

Response samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Successful account verification outcome.

{ "outcome": "verified", "checkedAt": "2018-09-01T10:37:36.923Z", "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource}" }, "curies": [ { "name": "verifications", "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}", "templated": true } ] } }

Verifications cardOnFile resource.

Successful account verification outcome.

SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verifications.accounts-v2.hal+json
required
object
currency
required
string
required
object
post
/verifications/accounts/intelligent/cardOnFile
Request samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Successful account verification outcome.

"{\"currency\": \"EUR\",\"paymentInstrument\": { \"type\": \"card/plain\", \"cardHolderName\": \"Joe Bloggs\", \"cardExpiryDate\": { \"month\": 1, \"year\": 2019 }, \"cardNumber\": \"4444333322221111\", \"verificationAddress\": { \"address1\": \"address1\", \"address2\": \"address2\", \"address3\": \"address3\", \"postalCode\": \"postalCode\", \"city\": \"city\", \"state\": \"state\", \"countryCode\": \"GB\" }, \"cvc\": \"101\"},\"merchant\": { \"entity\": \"default\"}}"
Responses

201

The account verification has been successful.

202

The account verification has been successful.

Response samples
application/vnd.worldpay.verifications.accounts-v2.hal+json

Successful account verification outcome.

{ "outcome": "verified", "schemeTransactionReference": "00000000000000000", "checkedAt": "2018-09-01T10:37:36.923Z", "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource}" }, "payments:cardOnFileAuthorize": { "href": "http://try.access.worldpay.com/payments/authorizations/cardOnFile/{resource}" }, "payments:recurringAuthorize": { "href": "http://try.access.worldpay.com/payments/authorizations/recurring/{resource}" }, "curies": [ { "name": "verifications", "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}", "templated": true } ] } }