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

Verifications dynamic cardOnFile resource.

Verifications (5)

TBD.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

testing (try)

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

live

https://access.worldpay.com/

Verification resource retrieval.

Request

Retrieval of a successful verification for oneTime and cardOnFile.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

No request payload

Responses

Retrieval request successful

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

outcomestringrequired

checkedAtstringrequired

riskFactorsArray of objects

riskstringrequired

detailstring

typestringrequired

paymentInstrumentobject

typestringrequired

cardobject

Response

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.

Request

Successful account verification outcome.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

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

merchantobjectrequired

entitystringrequired

mccstring

paymentFacilitatorobject

channelstring

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"

consumerBillPaymentboolean

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.

currencystringrequired

paymentInstrumentanyrequired

typestringrequired

Discriminator

cardHolderNamestring

cardExpiryDateobjectrequired

cardNumberstringrequired

verificationAddressobject

cvcstring

narrativeobject

line1stringrequired

line2string

transactionReferencestringrequired

customerobject

authenticationobjectrequired

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

The account verification has been successful.

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

outcomestringrequired

checkedAtstringrequired

riskFactorsArray of objects

riskstringrequired

detailstring

typestringrequired

paymentInstrumentobject

typestringrequired

cardobject

Response

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.

Request

Successful account verification outcome.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

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

merchantobjectrequired

entitystringrequired

mccstring

paymentFacilitatorobject

channelstring

NOTE: 3DS authentication data cannot be supplied for MOTO payments.

Value"moto"

consumerBillPaymentboolean

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.

currencystringrequired

paymentInstrumentanyrequired

typestringrequired

Discriminator

cardHolderNamestring

cardExpiryDateobjectrequired

cardNumberstringrequired

verificationAddressobject

cvcstring

narrativeobject

line1stringrequired

line2string

transactionReferencestringrequired

customerobject

authenticationanyrequired

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

The account verification has been successful.

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

outcomestringrequired

schemeTransactionReferencestring

checkedAtstringrequired

riskFactorsArray of objects

riskstringrequired

detailstring

typestringrequired

paymentInstrumentobject

typestringrequired

cardobject

Response

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.

Request

Successful account verification outcome.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

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

merchantobjectrequired

entitystringrequired

mccstring

paymentFacilitatorobject

channelstring

NOTE: 3DS authentication data cannot be supplied for MOTO payments.

Value"moto"

instructionobjectrequired

valueobjectrequired

paymentInstrumentanyrequired

narrativeobject

consumerBillPaymentboolean

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.

transactionReferencestringrequired

customerobject

authenticationobjectrequired

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

The account verification has been successful.

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

outcomestringrequired

checkedAtstringrequired

riskFactorsArray of objects

riskstringrequired

detailstring

typestringrequired

paymentInstrumentobject

typestringrequired

cardobject

Response

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.

Request

Successful account verification outcome.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

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

merchantobjectrequired

entitystringrequired

mccstring

paymentFacilitatorobject

channelstring

NOTE: 3DS authentication data cannot be supplied for MOTO payments.

Value"moto"

instructionobjectrequired

valueobjectrequired

paymentInstrumentanyrequired

narrativeobject

consumerBillPaymentboolean

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.

transactionReferencestringrequired

customerobject

authenticationanyrequired

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

The account verification has been successful.

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

outcomestringrequired

schemeTransactionReferencestring

checkedAtstringrequired

riskFactorsArray of objects

riskstringrequired

detailstring

typestringrequired

paymentInstrumentobject

typestringrequired

cardobject

Response

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.

Request

Successful account verification outcome.

Headers

Authorizationstringrequired

Default Basic Auth

Acceptstringrequired

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

Content-Typestringrequired

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

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

merchantobjectrequired

entitystringrequired

paymentInstrumentanyrequired

typestringrequired

Discriminator

accountTypestringrequired

accountNumberstringrequired

routingNumberstringrequired

companyNamestring

billToAddressobjectrequired

transactionReferencestringrequired

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

The account verification has been successful.

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

outcomestringrequired

descriptionstring

checkedAtstringrequired

Response

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.

Request

Responses

Do you like our page?

Verifications oneTime resource.

Request

Responses

Do you like our page?

Verifications cardOnFile resource.

Request

Responses

Do you like our page?

Verifications dynamic oneTime resource.

Request

Responses

Do you like our page?

Verifications dynamic cardOnFile resource.

Request

Responses

Do you like our page?

Verifications ACH resource.

Request

Responses

Do you like our page?