20 March 2025
Version History V2.0
Welcome to the Version History for the VoP Gateway API Specification. This page provides a detailed overview of the updates made in this release, aimed at aligning formats, refining descriptions, and implementing select functional enhancements.
Reviewing this version history will help you understand the scope of the updates and assess any necessary adjustments for a smooth transition to V2.0.
Each section outlines the changes made, including both the previous and updated values, along with a classification of the change type:
- Format Change: Adjustments to improve standardisation, readability, or consistency. These changes do not impact integration logic.
- Functional Change: Modifications that alter API behaviour or data handling. These changes may require updates to your integration.
Auth API Specification Changes
Functional Changes
| Section | Field | Old Value | New Value | Comment |
|---|---|---|---|---|
| How does it work? | Link | API key | client_id | Updated terminology to be more accurate |
| How does it work? | Link | secret | client_secret | Updated terminology to be more accurate |
Format Changes
| Section | Field | Old Value | New Value |
|---|---|---|---|
| Introduction | Link | N/A | Additional description added with reference to RFC 6749 |
| Go directly to | Link | N/A | Updated links |
| Request Headers | Link | Empty | Added additional heading |
| Request Headers | Link | Headers | Request Headers |
| Request Headers | Link | Empty | Added examples of headers |
| Request Headers | Note | Replace "hostValue"... | Bullet point removed |
| Request Headers | Content-Type | Type: application/x-www-form-urlencoded | Type: String |
| Request Headers | Authorization | Type: Basic | Type: String |
| Request Body | data-urlencode | Type: grant_type=client_credentials | Type: String |
| Request Body | data-urlencode | Empty | Added example |
| Response Body | All Fields | Empty | Added all fields and descriptions |
API Specification Changes
Functional Changes
| Section | Field | Old Value | New Value |
|---|---|---|---|
| Request Body | identification | Type: String | Type: Object |
| Request Body | schemeNameProprietary | schemeNamePropietary | schemeNameProprietary - spelling error |
| Request Body | unstructuredRemittanceInformation | N/A | Moved to below IBAN (field order) |
| Request Body | iban | N/A | Format: Added max length of 34 characters |
| Request Body | partyAgent | Mandatory | Conditional & added usage rule |
| Request Body | Examples | N/A | Updated examples with unstructuredRemittanceInformation as an Array of Strings |
| Response Headers | Content-Type | Empty | Added |
| Response Body | additionalPartyInformation | Tag: Add-On Feature | Tag: Conditional |
| Response Body | advancedInfo | Empty | New object added to cater for the SurePay Plus service |
| Response Body | detailedMatchResult | N/A | Moved to below status (field order) |
| Response Body | fraudRiskIndicator | Type: String | Type: Object |
| Response Body | switchingInformation | Type: String | Type: Object |
| Response Body | Examples | Empty | Added "advancedInfo" object |
| Response Body | Examples | nameMatched | matchedName |
| Response Body | Examples | Empty | Additional examples added |
| Error Response Headers | X-Request-Id | Empty | Added to be more accurate |
| Error Response Body | code | N/A | Added link to possible values |
| Error Response Body | type | N/A | Added format of max 70 characters |
| Error Response Body | title | N/A | Added link to possible values |
| Error Response Body | title | N/A | Added format of max 70 characters |
| Functional Errors | Error Message Codes | TIMESTAMP_INVALID | Removed |
| Functional Errors | Error Message Codes | Empty | INTERNAL_SERVER_ERROR added with description |
| Error Table | unstructuredRemittanceInformation | N/A | Removed from mandatory error description as its not mandatory |
| Error Table | Internal Server Error | N/A | Removed as its covered in Functional Errors |
| Error Table | CLIENT_INCONSISTENT | N/A | Removed as its covered in Functional Errors |
| Error Table | Certificate Items | N/A | Removed |
| Error Table | Duplicated_Field | N/A | Removed |
| Enumeration List | nameSchemeCode | Link | Updated descriptions and formats |
Format Changes
| Section | Field | Old Value | New Value |
|---|---|---|---|
| Introduction | Link | N/A | Grammar update |
| Go directly to | Link | N/A | Update Links |
| Request Headers | Link | Empty | Added additional heading |
| Request Headers | Link | Headers | Request Headers |
| Request Headers | Content-Type | Type: application/json | Type: String |
| Request Headers | Content-Type | N/A | Added example |
| Request Headers | Authorization | Type: Bearer | Type: String |
| Request Headers | Accept | Empty | Added field to be more accurate |
| Request Headers | Example | N/A | Added "Accept" to example |
| Request Headers | Accept-Language | nameSuggestion | matchedName |
| Request Body | All Optional Fields | N/A | Added Optional tag |
| Request Body | All Fields | N/A | Updated grammar & spelling |
| Request Body | issuer | N/A | Added external links to provide more information |
| Request Body | Examples | N/A | Updated title of each example to be more descriptive |
| Response Headers | Link | Empty | Added additional heading |
| Response Headers | Link | Headers | Response Headers |
| Response Headers | X-Request-Id | N/A | Updated description |
| Response Body | All Fields | N/A | Updated grammar & spelling |
| Response Body | All Optional Fields | N/A | Added Optional tag |
| Response Body | Examples | N/A | Updated title of each example to be more descriptive |
| Error Response Headers | All Fields | N/A | Updated grammar & spelling |
| Error Response Headers | Examples | Empty | Added |
| Error Response Body | All Optional Fields | N/A | Added Optional tag |
| Error Table | All Fields | N/A | Updated descriptions (grammar & spelling) |
| Performance & Availability | Link | Empty | Added |
| Encoding & Special Characters | Link | Empty | Added |
| Security | Link | N/A | Updated grammar & spelling |
Switch Check Changes
Functional Changes
| Section | Field | Old Value | New Value |
|---|---|---|---|
| Request Body | Examples | N/A | Updated examples with unstructuredRemittanceInformation as an Array of Strings |
| Response Body | Example | N/A | Added "additionalPartyInformation" object as per VoP Gateway Spec |
| Response Body | Example | N/A | Added "advancedInfo" object as per VoP Gateway Spec, this shows an example of the SurePay Plus offering in conjunction with the SwitchCheck |
Format Changes
| Section | Field | Old Value | New Value |
|---|---|---|---|
| Introduction | Link | Spelling & grammar fixes | |
| Response Body | Description | account object | additionalPartyInformation object |
| Response Body | switchingInformation | Tag: Conditionally Returned | Tag: Conditional |
| Response Body | switchingServiceForAccount | Tag: Conditionally Returned | Tag: Conditional |
| Response Body | switchedIban | Tag: Conditionally Returned | Tag: Conditional |
| Response Body | Example | N/A | New Example Added: VoP Standard with SwitchCheck add-on, this shows the response without the "advancedInfo" object |
| Response Body | Example Name | Inactive account switched | VoP Plus with SwitchCheck add-on: Natural Person with Inactive Account |
| Response Body | Example Name | Active account switched | VoP Plus with SwitchCheck add-on: Natural Person with Active Account |