Access Worldpay
/
Verifications

Verifications (4)

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-v4.hal+json
object (verifications_Verifications_200_response)  
 
Response samples
application/vnd.worldpay.verifications.accounts-v4.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/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
}
]
}
}
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-v4.hal+json
outcome
required
string 
 
checkedAt
required
string 
 
Array of objects 
 
object 
 
Response samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Retrieval of a successful verification
{
"outcome": "verified",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_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-v4.hal+json
required
object 
 
currency
required
string 
 
required
any 
 
transactionReference
required
string 
 
object 
 
post
/verifications/accounts/intelligent/oneTime
Request samples
application/vnd.worldpay.verifications.accounts-v4.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\",\"postalCode\": \"postalCode\",\"city\": \"city\",\"countryCode\": \"GB\"},\"cvc\": \"101\"},\"merchant\": {\"entity\": \"default\"}, \"transactionReference\": \"transactionReference\"}"
Responses
201
The account verification has been successful.
Response samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
{
"outcome": "verified",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_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-v4.hal+json
required
object 
 
currency
required
string 
 
required
any 
 
transactionReference
required
string 
 
object 
 
post
/verifications/accounts/intelligent/cardOnFile
Request samples
application/vnd.worldpay.verifications.accounts-v4.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\", \"postalCode\": \"postalCode\", \"city\": \"city\", \"countryCode\": \"GB\" }, \"cvc\": \"101\"},\"merchant\": { \"entity\": \"default\"}, \"transactionReference\": \"transactionReference\"}"
Responses
201
The account verification has been successful.
202
The account verification has been successful.
Response samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
{
"outcome": "verified",
"schemeTransactionReference": "00000000000000000",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_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}"
},
"payments:recurringSale": {
"href": "http://try.access.worldpay.com/payments/sales/recurring/{resource}"
},
"curies": [
{
"name": "verifications",
"href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
"templated": true
}
]
}
}
Verifications dynamic oneTime resource.
Successful account verification outcome.
SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verifications.accounts-v4.hal+json
required
object 
 
required
object 
 
transactionReference
required
string 
 
object 
 
post
/verificationsaccounts//dynamic/oneTime
Request samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
"{\"merchant\": {\"entity\": \"default\"}, \"transactionReference\":  \"transactionReference\", \"instruction\": {\"value\": {\"amount\": 100, \"currency\": \"GBP\"}, \"paymentInstrument\": {\"type\": \"card/plain\",\"cardHolderName\": \"Joe Bloggs\",\"cardExpiryDate\": {\"month\": 1,\"year\": 2019},\"cardNumber\": \"4444333322221111\",\"verificationAddress\": { \"address1\": \"address1\",\"postalCode\": \"postalCode\",\"city\": \"city\",\"countryCode\": \"GB\"},\"cvc\": \"101\"}}}"
Responses
201
The account verification has been successful.
Response samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
{
"outcome": "verified",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_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 dynamic oneTime resource.
Successful account verification outcome.
SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verifications.accounts-v4.hal+json
required
object 
 
required
object 
 
transactionReference
required
string 
 
object 
 
post
/verificationsaccounts/dynamic/cardOnFile
Request samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
"{\"merchant\": {\"entity\": \"default\"}, \"transactionReference\":  \"transactionReference\", \"instruction\": {\"value\": {\"amount\": 100, \"currency\": \"GBP\"}, \"paymentInstrument\": {\"type\": \"card/plain\",\"cardHolderName\": \"Joe Bloggs\",\"cardExpiryDate\": {\"month\": 1,\"year\": 2019},\"cardNumber\": \"4444333322221111\",\"verificationAddress\": { \"address1\": \"address1\",\"postalCode\": \"postalCode\",\"city\": \"city\",\"countryCode\": \"GB\"},\"cvc\": \"101\"}}}"
Responses
201
The account verification has been successful.
202
The account verification has been successful.
Response samples
application/vnd.worldpay.verifications.accounts-v4.hal+json
Successful account verification outcome.
{
"outcome": "verified",
"schemeTransactionReference": "00000000000000000",
"checkedAt": "2018-09-01T10:37:36.923Z",
"riskFactors": [
{
"risk": "matched",
"type": "cvc"
},
{
"risk": "matched",
"detail": "postcode",
"type": "avs"
},
{
"risk": "matched",
"detail": "address",
"type": "avs"
}
],
"paymentInstrument": {
"type": "card/plain",
"card": {
"number": {
"bin": "444433",
"last4Digits": "1111"
},
"countryCode": "GB",
"expiryDate": {
"month": 12,
"year": 2029
},
"brand": "visa",
"fundingType": "debit",
"issuer": {
"name": "cardIssuer"
},
"category": "consumer",
"paymentAccountReference": "reference"
}
},
"_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}"
},
"payments:recurringSale": {
"href": "http://try.access.worldpay.com/payments/sales/recurring/{resource}"
},
"curies": [
{
"name": "verifications",
"href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
"templated": true
}
]
}
}