Verifications

Verifications (5)

Download OpenAPI specification:Download

TBD.

Servers

testing (try)

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

live

https://access.worldpay.com/

Verification resource retrieval.

Retrieval of a successful verification for oneTime and cardOnFile.

SecurityHTTP: BasicAuth

Request

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

get
/verifications/accounts/verification

Request samples

Responses

200

Retrieval request successful

Response Schema: application/vnd.worldpay.verifications.accounts-v5+json

outcome required	string
checkedAt required	string
	Array of objects
	object

Response samples

application/vnd.worldpay.verifications.accounts-v5+json

Retrieval of a successful verification for oneTime

{
"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 oneTime resource.

Successful account verification outcome.

SecurityHTTP: BasicAuth

Request

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

required	object
channel	string (channel) The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order transaction. If channel is not provided, the authorization will be processed as ecommerce by default. NOTE: 3DS `authentication` data cannot be supplied for MOTO payments. Value: "moto"
consumerBillPayment	boolean (consumerBillPayment) If you are registered with Visa as a Consumer Bill Payment Service (CBPS), you must set this to `true` for any payments associated with the CBPS.
currency required	string
required	any
	object
transactionReference required	string
	object

post
/verifications/accounts/intelligent/oneTime

Request samples

application/vnd.worldpay.verifications.accounts-v5+json

Successful account verification outcome.

{
"currency": "EUR",
"paymentInstrument": {
"type": "card/plain",
"cardHolderName": "Joe Bloggs",
"cardExpiryDate": {
"month": 1,
"year": 2100
},
"cardNumber": "4444333322221111",
"verificationAddress": {
"address1": "address1",
"postalCode": "postalCode",
"city": "city",
"countryCode": "GB"
},
"cvc": "101"
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
},
"merchant": {
"entity": "default"
},
"transactionReference": "transactionReference"
}

Responses

201

The account verification has been successful.

Response samples

application/vnd.worldpay.verifications.accounts-v5+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

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

required	object
channel	string (channel) The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order transaction. If channel is not provided, the authorization will be processed as ecommerce by default. NOTE: 3DS `authentication` data cannot be supplied for MOTO payments. Value: "moto"
consumerBillPayment	boolean (consumerBillPayment) If you are registered with Visa as a Consumer Bill Payment Service (CBPS), you must set this to `true` for any payments associated with the CBPS.
currency required	string
required	any
	object
transactionReference required	string
	object

post
/verifications/accounts/intelligent/cardOnFile

Request samples

application/vnd.worldpay.verifications.accounts-v5+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"
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
},
"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-v5+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

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

required	object
channel	string (channel) The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order transaction. If channel is not provided, the authorization will be processed as ecommerce by default. NOTE: 3DS `authentication` data cannot be supplied for MOTO payments. Value: "moto"
required	object
transactionReference required	string
	object

post
/verifications/accounts/dynamic/oneTime

Request samples

application/vnd.worldpay.verifications.accounts-v5+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"
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
}
}
}

Responses

201

The account verification has been successful.

Response samples

application/vnd.worldpay.verifications.accounts-v5+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 cardOnFile resource.

Successful account verification outcome.

SecurityHTTP: BasicAuth

Request

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

required	object
channel	string (channel) The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order transaction. If channel is not provided, the authorization will be processed as ecommerce by default. NOTE: 3DS `authentication` data cannot be supplied for MOTO payments. Value: "moto"
required	object
transactionReference required	string
	object

post
/verifications/accounts/dynamic/cardOnFile

Request samples

application/vnd.worldpay.verifications.accounts-v5+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"
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
}
}
}

Responses

201

The account verification has been successful.

202

The account verification has been successful.

Response samples

application/vnd.worldpay.verifications.accounts-v5+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 ACH resource.

Successful account verification outcome.

SecurityHTTP: BasicAuth

Request

header Parameters

Authorization required	string Default: Basic Auth
Accept required	string Default: application/vnd.worldpay.verifications.accounts-v5+json
Content-Type required	string Default: application/vnd.worldpay.verifications.accounts-v5+json

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

required	object
channel	string (channel) The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order transaction. If channel is not provided, the authorization will be processed as ecommerce by default. NOTE: 3DS `authentication` data cannot be supplied for MOTO payments. Value: "moto"
consumerBillPayment	boolean (consumerBillPayment) If you are registered with Visa as a Consumer Bill Payment Service (CBPS), you must set this to `true` for any payments associated with the CBPS.
required	any
transactionReference required	string

post
/verifications/accounts/ach

Request samples

application/vnd.worldpay.verifications.accounts-v5+json

Successful account verification outcome.

{
"merchant": {
"entity": "default"
},
"transactionReference": "1234567",
"paymentInstrument": {
"type": "bankAccountUS",
"accountType": "corporateSavings",
"accountNumber": "1234567890",
"routingNumber": "011400495",
"companyName": "companyName",
"billToAddress": {
"firstName": "John",
"lastName": "Smith",
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"region": "state",
"postalCode": "postalCode",
"countryCode": "US",
"telephoneNumber": "4085551212"
}
}
}

Responses

201

The account verification has been successful.

Response samples

application/vnd.worldpay.verifications.accounts-v5+json

Successful account verification outcome.

{
"outcome": "verified",
"checkedAt": "2021-09-27T18:02:16.475Z",
"_links": {
"curies": [
{
"name": "verifications",
"href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
"templated": true
}
]
}
}

Verifications (5)

Verification resource retrieval.

header Parameters

Response Schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?

Verifications oneTime resource.

header Parameters

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?

Verifications cardOnFile resource.

header Parameters

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?

Verifications dynamic oneTime resource.

header Parameters

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?

Verifications dynamic cardOnFile resource.

header Parameters

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?

Verifications ACH resource.

header Parameters

Request Body schema: application/vnd.worldpay.verifications.accounts-v5+json

Was this helpful?