Access Worldpay
/
Verification
/
Verifications dynamic oneTime resource.

Verifications (3)

TBD.

Download OpenAPI description
openapi.json
openapi.yaml
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-v3.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
currencystringrequired
paymentInstrumentobjectrequired
typestringrequired
cardHolderNamestringrequired
cardExpiryDateobjectrequired
cardNumberstringrequired
verificationAddressobject
cvcstring
transactionReferencestringrequired
application/vnd.worldpay.verifications.accounts-v3.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-v3.hal+json
outcomestringrequired
checkedAtstringrequired
Response
application/vnd.worldpay.verifications.accounts-v3.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.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v3.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
currencystringrequired
paymentInstrumentobjectrequired
typestringrequired
cardHolderNamestringrequired
cardExpiryDateobjectrequired
cardNumberstringrequired
verificationAddressobject
cvcstring
transactionReferencestringrequired
application/vnd.worldpay.verifications.accounts-v3.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-v3.hal+json
outcomestringrequired
schemeTransactionReferencestring
checkedAtstringrequired
Response
application/vnd.worldpay.verifications.accounts-v3.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
      }
    ]
  }
}

Verifications dynamic oneTime resource.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v3.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
instructionobjectrequired
valueobjectrequired
paymentInstrumentobjectrequired
transactionReferencestringrequired
application/vnd.worldpay.verifications.accounts-v3.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-v3.hal+json
outcomestringrequired
checkedAtstringrequired
Response
application/vnd.worldpay.verifications.accounts-v3.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 dynamic oneTime resource.

Request

Successful account verification outcome.

Bodyapplication/vnd.worldpay.verifications.accounts-v3.hal+json
merchantobjectrequired
entitystringrequired
mccstring
paymentFacilitatorobject
instructionobjectrequired
valueobjectrequired
paymentInstrumentobjectrequired
transactionReferencestringrequired
application/vnd.worldpay.verifications.accounts-v3.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-v3.hal+json
outcomestringrequired
schemeTransactionReferencestring
checkedAtstringrequired
Response
application/vnd.worldpay.verifications.accounts-v3.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
      }
    ]
  }
}