# Versioning and change log

This log details any breaking and non-breaking API changes we have released for our Verifications service.

Prerequisite
Make yourself familiar with our [API principles](/access/products/reference/api-principles) to ensure a resilient integration.

## Versioning log

#### Version 6 (27 June 2024)

details
summary
Restructure of resources
The new [Card Verifications](/access/products/card-verifications) API introduces a new single endpoints and consistent JSON structure to simplify your integration.

* removal of separate endpoints for intelligent and dynamic verifications
* field value based routing for one time vs card on file
* request and response field name changes to align with industry standard
* added support for network payment tokens
* added support for AFT related optional fields


#### Version 5 (18 June 2020)

details
summary
Dynamic statement narrative
- you must now submit `narrative` in your [intelligent](/access/products/card-verifications/v5/verifications#intelligent-verification) and [dynamic](/access/products/card-verifications/v5/verifications#dynamic-verification) verification request
- this is no longer a breaking change. `narrative` is now an optional field as of 02/15/2021


#### Version 4 (25 September 2019)

details
summary
Strict parsing
- header change to "Content-Type: application/vnd.worldpay.verifications.accounts-v4+json"
- sending any fields not recorded in our documentation returns an [error](/access/products/reference/worldpay-error-responses)


#### Version 3 (16 July 2019)

details
summary
New mandatory field
- header change to "Content-Type: application/vnd.worldpay.verifications.accounts-v3+json"
- new mandatory [`transactionReference`](/access/products/reference/formatting#transaction-reference-format) field


#### Version 2 (07 June 2019)

details
summary
Field rename and endpoint removal
- header change to "Content-Type: application/vnd.worldpay.verifications.accounts-v2+json"
- `verifications:recurring` action link and `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/recurring` resource link removed
- `cardOnFile` endpoint now returns [`cardOnFileAuthorize`](/access/products/card-payments/v6/authorise-a-cardonfile-payment) and [`recurringAuthorize`](/access/products/card-payments/v6/authorise-a-recurring-payment) action links in the response
- `merchant.reference` renamed to `merchant.entity`
- `billingAddress` renamed to `verificationAddress`


## Change log (non-breaking changes)

#### Google Pay and Samsung Pay decrypted payment instrument types added to version 6 (11 March 2026)

details
summary
More details
You can now use Google Pay and Samsung Pay decrypted payment instrument types while sending a [card verification request](/access/products/card-verifications/openapi/other/cardverify#other/cardverify/request/body).

#### Payfac URL support in request (all versions) (11 September 2025)

details
summary
More details
If you are a PayFac merchant, you can now optionally optional a `submerchant.url` in the [card verification request](/access/products/card-verifications/openapi/other/cardverify#other/cardverify/request/body). This allows you to be compliant with scheme requirements.

#### Scheme reference in every response (12 May 2025)

details
summary
More details
You now receive a scheme reference in your [card verification response](/access/products/card-verifications/openapi/other/cardverify#other/cardverify/response&c=201/body) irrespective of the outcome. We previously only returned this in `verified` responses. This advises you that a card was tokenized even though the card verification itself failed.

#### Additional funds transfer types (13 March 2025)

details
summary
More details
You can now send additional fund transfer [`type` and `purpose` values](/access/products/card-verifications/openapi/other/cardverify#other/cardverify/t=request&path=&oneof=0/instruction/fundstransfer/type) in the `fundsTransfer` object in your [verification request](/access/products/card-verifications/verifications#example-request). This allow you to be compliant with card scheme requirements for fund transfers.

details
summary
2024
#### Optional billing address (21 November 2024)

details
summary
More details
You can now send an optional `billingAddress` object in your [verification request](/access/products/card-verifications/verifications#example-request) for `card/token`, `card/networkToken` and `card/networkToken+ApplePay` payment instrument types.

#### Cardholder name inquiries (25 July 2024)

details
summary
More details
You can now make a `nameInquiry` for Visa cards with our [Card Verifications API](/access/products/card-verifications/verifications). This allows you to check the validity of the cardholder name provided.

#### New optional channel field in request (v5) (25 March 2024)

details
summary
More details
You can now send a `channel` field within [your request](/access/products/card-verifications/v5/verifications).

#### New optional consumerBillPayment field in instruction object (v5) (25 March 2024)

details
summary
More details
You can now send a `consumerBillPayment` flag within the instruction object in [your request](/access/products/card-verifications/v5/verifications). You must set this to `true` for any verifications made for the purpose of paying consumer bills in the future.

#### New optional recipient object in request (all versions) (18 January 2024)

details
summary
More details
You now have the option to send a `recipient` object within your [Verification request](/access/products/card-verifications/v5/verifications). You should send this if your MCC is 6012 or 6051 to remain PSD2 compliant and avoid acquirers refusing your payment.

details
summary
2023
#### New optional email and telephone fields in payment facilitator merchant block (24 August 2023)

details
summary
More details
You now have the option to send an `email` and `telephone` field within your payment facilitator merchant object.

#### Payment facilitator sub-merchant ID max length increased to 15 (16 August 2023)

details
summary
More details
The paymentFacilitator `merchantId` now has a maximum digit length of 15. The previous limit was 7.

#### New optional refusalAdvice field in verification refusal response (20 April 2023)

details
summary
More details
You will now receive a Merchant Advice Code (MAC) as `overrideName` in the [not verified response](/access/products/card-verifications/v5/verifications#verifications-response), if you have requested to receive this.

#### Additional fundingType values in response (v4 + v5) (01 March 2023)

details
summary
More details
The field `fundingType` in the `paymentInstrument` object of your [response](/access/products/card-verifications/v5/verifications#verifications-response) can now have the following additional values:

ul
li
`chargeCard`
li
`prepaid`
li
`deferreddebit`
We have added these to the already existing values of `debit` and `credit`.

#### New optional category field in response (v4 + v5) (01 March 2023)

details
summary
More details
You now have an additional field of `category` in the card section of your [oneTime response](/access/products/card-verifications/v5/verifications#verifications-response) if you have opted in to receive it. This field populates data from the cardbin:productType field value.

details
summary
2022
#### ACH verification (v5) (07 November 2022)

details
summary
More details
- You can now send [verification requests](/access/products/card-verifications/v5/verifications#ach-verification) against US bank accounts to `ACH` endpoint:
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/ach`


#### Optional CVC field in the verification request (v5) (11 October 2022)

details
summary
More details
- You can now submit the CVC as an optional field in the [verification request with token](/access/products/card-verifications/v5/verifications) for both `oneTime` and `cardOnFile` endpoints.
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/oneTime`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/cardOnFile`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/oneTime`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/cardOnFile`


#### Merchant initiated transaction reason support on CardOnFile Endpoint (v5) (20 June 2022)

details
summary
More details
- You can now supply `storedCredentials.reason` as an optional field for both `cardOnFile` endpoints:
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/cardOnFile`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/cardOnFile`


details
summary
2021
#### Cardholder name now an optional field (v5) (11 March 2021)

details
summary
More details
- The `paymentInstrument.cardHolderName` field is no longer mandatory in v5 requests.


#### Updates to statement narrative in requests (v5) (15 February 2021)

details
summary
More details
- The `narrative` block is no longer a mandatory field in v5 requests to cater for upstream services


details
summary
2020
#### Apple Pay decrypted verification (v4 + v5) (23 November 2020)

details
summary
More details
You can now submit your v4 and v5 [intelligent](/access/products/card-verifications/v5/verifications#intelligent-verification) and [dynamic](/access/products/card-verifications/v5/verifications#dynamic-verification) verification with a decrypted Apple Pay `paymentInstrument`. This only applies to the `cardOnFile` endpoints:

`https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/cardOnFile`

`https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/cardOnFile`

#### Additional card metadata fields in response (v4) (01 May 2020)

details
summary
More details
- we are returning [`paymentInstrument`](/access/products/card-verifications/v4/verifications#payment-instrument) in `verified` and `notVerified` responses for enabled merchants


#### Version support for 3DS (v4) (07 February 2020)

details
summary
More details
- you can now submit the following values for `authentication.version` in your [3DS](/access/products/card-verifications/v4/verifications#3ds) request:
  - for 3DS1 - `1.0.2`
  - for 3DS2 - `2.1.0` or  `2.2.0`


#### Additional fields in response (v4) (27 January 2020)

details
summary
More details
- we are returning [`riskFactors`](/access/products/card-verifications/v4/verifications#risk-factors) in `verified` and `notVerified` responses


details
summary
2019
#### cardOnFile verifications with tokens (v4) (31 December 2019)

details
summary
More details
- you can now send [verification requests](/access/products/card-verifications/v4/verifications) with a token to both `cardOnFile` endpoints:
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/cardOnFile`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/cardOnFile`


#### oneTime verifications with tokens (v4) (20 November 2019)

details
summary
More details
- you can now send [verification requests](/access/products/card-verifications/v4/verifications) with a token to both `oneTime` endpoints:
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/intelligent/oneTime`
  - `https://try.access.worldpay-bsh.securedataplatform.com/verifications/accounts/dynamic/oneTime`


#### Additional action link (v4) (20 November 2019)

details
summary
More details
- [`recurringSale`](/access/products/card-payments/v6/take-a-sale) action link is now returned in the `cardOnFile` verification responses. This allows for recurring sale transactions.