Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Verifications (4)

TBD.

Download OpenAPI description
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Root

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

Operations

Verifications

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

Operations

Verification

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

Operations

Verifications oneTime resource.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
pfIdstringrequired
isoIdstring
subMerchantobjectrequired
currencystringrequired
paymentInstrumentanyrequired
typestringrequired
Discriminator
cardHolderNamestringrequired
cardExpiryDateobjectrequired
monthintegerrequired
yearintegerrequired
cardNumberstringrequired
verificationAddressobject
address1string
postalCodestringrequired
citystringrequired
countryCodestringrequired
cvcstring
transactionReferencestringrequired
customerobject
authenticationobjectrequired
versionstringrequired
typestringrequired
ecistringrequired
authenticationValuestring
transactionIdstring
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

The account verification has been successful.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
outcomestringrequired
checkedAtstringrequired
riskFactorsArray of objects
riskstringrequired
detailstring
typestringrequired
paymentInstrumentobject
typestringrequired
cardobject
numberobject
countryCodestring
expiryDateobject
brandstring
fundingTypestring
issuerobject
categorystring
paymentAccountReferencestring
Response
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.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
pfIdstringrequired
isoIdstring
subMerchantobjectrequired
currencystringrequired
paymentInstrumentanyrequired
typestringrequired
Discriminator
cardHolderNamestringrequired
cardExpiryDateobjectrequired
monthintegerrequired
yearintegerrequired
cardNumberstringrequired
verificationAddressobject
address1string
postalCodestringrequired
citystringrequired
countryCodestringrequired
cvcstring
transactionReferencestringrequired
customerobject
authenticationanyrequired
versionstringrequired
typestringrequired
Discriminator
ecistringrequired
authenticationValuestring
transactionIdstring
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

The account verification has been successful.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
outcomestringrequired
schemeTransactionReferencestring
checkedAtstringrequired
riskFactorsArray of objects
riskstringrequired
detailstring
typestringrequired
paymentInstrumentobject
typestringrequired
cardobject
numberobject
countryCodestring
expiryDateobject
brandstring
fundingTypestring
issuerobject
categorystring
paymentAccountReferencestring
Response
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.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
pfIdstringrequired
isoIdstring
subMerchantobjectrequired
instructionobjectrequired
valueobjectrequired
amountstringrequired
currencystringrequired
paymentInstrumentanyrequired
typestringrequired
Discriminator
cardHolderNamestringrequired
cardExpiryDateobjectrequired
cardNumberstringrequired
verificationAddressobject
cvcstring
transactionReferencestringrequired
customerobject
authenticationobjectrequired
versionstringrequired
typestringrequired
ecistringrequired
authenticationValuestring
transactionIdstring
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

The account verification has been successful.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
outcomestringrequired
checkedAtstringrequired
riskFactorsArray of objects
riskstringrequired
detailstring
typestringrequired
paymentInstrumentobject
typestringrequired
cardobject
numberobject
countryCodestring
expiryDateobject
brandstring
fundingTypestring
issuerobject
categorystring
paymentAccountReferencestring
Response
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.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v4.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
pfIdstringrequired
isoIdstring
subMerchantobjectrequired
instructionobjectrequired
valueobjectrequired
amountstringrequired
currencystringrequired
paymentInstrumentanyrequired
typestringrequired
Discriminator
cardHolderNamestringrequired
cardExpiryDateobjectrequired
cardNumberstringrequired
verificationAddressobject
cvcstring