Download Excel File Format
Introduction
This section serves as a comprehensive guide to the required template format for performing bulk Verification of Payee (VOP) checks within the VOP Portal. The template detailed here is designed for use with Excel file, providing a consistent and efficient way for submitting large batches of IBANs for verification.
Excel Standard
| Field | Man* | Format | Description |
|---|---|---|---|
| E2E ID | M | String | This is the original unique end to end ID passed with the Excel uploaded. It enables end-to-end traceability. Usage Rule: If provided it is used otherwise it’s generated by SurePay on behalf of the customer. |
| Beneficiary IBAN | M | String Max Length: 34 | The International Bank Account Number of the Beneficiary. Format: ^[A-Z]\{2}[0-9]\{2}[A-Z0-9]\{1,30}$ |
| Beneficiary Name | C | String Max Length: 140 | The name of the Beneficiary:
Optional for organisations. name is included, the identification fields cannot be used in the same request. |
| Beneficiary ORG ID | C | String | This is the original requested Org ID which is a unique identifier assigned to the beneficiary organisation. |
| Name Match | C | Enum | Describes the result of the IBAN-Name Check. Usage Rule: Only applicable when name field has been added in the request.Possible Values:
|
| ORG ID Match | C | Enum | Describes the result of the IBAN-ID Check. Usage Rule: Only applicable when identification field has been added in the request.Possible Values:
|
| Name Suggestion | C | String Max Length: 140 | Returns the corrected name of the account holder. Usage Rule: Only returned when the result is a close match or in the case of an organisation, a no match. |
| Error Type | C | String Max Length: 70 | Identifies the problem type returned during the processing of a VOP request. Usage Rule: Only returned if row has an error. |
| Error Code | C | String | Message code to explain the nature of the underlying error. Usage Rule: Only returned if row has an error. Possible Values:
|
| Error Title | O | String Max Length: 70 | Short human readable description of error type. Could be in local language. To be provided by the Responding PSP. Possible Values:
|
| Error Status | O | String | HTTP response code generated by the Server. If contained, this is more relevant as the actual http response code in the actual response, because it is introduced by the Application Server. Possible Values:
|
| Error Detail | O | String Max Length: 500 | Detailed human readable text specific to this instance of the error. For example: Field Beneficiary Name or Beneficiary ORG ID must not be null. |
* Man = Mandatory. Values: M = Mandatory, C = Conditional, O = Optional
Excel Plus
| Field | Man* | Format | Description |
|---|---|---|---|
| E2E ID | M | String | This is the original unique end to end ID passed with the Excel uploaded. It enables end-to-end traceability. Usage Rule: If provided it is used otherwise it’s generated by SurePay on behalf of the customer. |
| Beneficiary IBAN | M | String Max Length: 34 | The International Bank Account Number of the Beneficiary. Format: ^[A-Z]\{2}[0-9]\{2}[A-Z0-9]\{1,30}$ |
| Beneficiary Name | C | String Max Length: 140 | The name of the Beneficiary:
Optional for organisations. name is included, the identification fields cannot be used in the same request. |
| Beneficiary ORG ID | C | String | This is the original requested Org ID which is a unique identifier assigned to the beneficiary organisation. |
| Name Match | C | Enum | Describes the result of the IBAN-Name Check. Usage Rule: Only applicable when name field has been added in the request.Possible Values:
|
| ORG ID Match | C | Enum | Describes the result of the IBAN-ID Check. Usage Rule: Only applicable when identification field has been added in the request.Possible Values:
|
| Name Suggestion | C | String Max Length: 140 | Returns the corrected name of the account holder. Usage Rule: Only returned when the result is a close match or in the case of an organisation, a no match. |
| Account Holder Type | C | Enum | Describes the type of the account holder. Usage Rule: Only returned for VoP Plus. Possible Values:
|
| Account Status | C | Enum | The status of the account. Usage Rule: Only returned for VoP Plus. Possible Values:
|
| Detailed Result | C | Enum | Additional information in case the matching result was not a match. Usage Rule: Only returned for VoP Plus. Possible Values:
|
| Town Name | C | String | The residence town/city of the account holder. Usage Rule: Only returned for VoP Plus. |
| Switched Account Status | C | Enum | Usage Rule: Only returned if the Switching Service is enabled. Possible Values:
|
| New IBAN | C | String Max Length: 34 | Usage Rule: Only returned if the Switching Service is enabled. |
| Error Type | C | String Max Length: 70 | Identifies the problem type returned during the processing of a VOP request. Usage Rule: Only returned if row has an error. |
| Error Code | C | String | Message code to explain the nature of the underlying error. Usage Rule: Only returned if row has an error. Possible Values:
|
| Error Title | O | String Max Length: 70 | Short human readable description of error type. Could be in local language. To be provided by the Responding PSP. Possible Values:
|
| Error Status | O | String | HTTP response code generated by the Server. If contained, this is more relevant as the actual http response code in the actual response, because it is introduced by the Application Server. Possible Values:
|
| Error Detail | O | String Max Length: 500 | Detailed human readable text specific to this instance of the error. For example: Field Beneficiary Name or Beneficiary ORG ID must not be null. |
* Man = Mandatory. Values: M = Mandatory, C = Conditional, O = Optional