Download CSV 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.

CSV Standard

Field	Man*	Format	Description
E2E ID	M	String	This is the original unique end to end ID passed with the CSV 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.
Request 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}$`
Request Name	C	String Max Length: 140	The name of the Beneficiary: Mandatory for Natural Person. Optional for organisations. Usage Rule: If `name` is included, the `identification` fields cannot be used in the same request.
Request ID	C	String	Usage Rule: Only returned if provided in the original request.
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: MTCH: (Match): The name matches exactly with a record in the system – a confirmed match. CMTC: (Close Match): The name closely matches a record but may have slight differences, like spelling variations – a partial or approximate match. NMTC: (No Match): The name doesn't match any records in the system – no match found. NOAP: (Not Applicable): Verification check not possible, validation check is not applicable.
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: MTCH: (Match): The ID matches a record in the system - a confirmed match. NMTC: (No Match): The ID does not match any records - no match found. NOAP: (Not Applicable): The ID code is not supported or known by the Responding PSP - Verification check not possible, validation check is not applicable.
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 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: 400 - Bad request
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: FORMAT_ERROR: The request does not meet the required format or validation rules. INTERNAL_SERVER_ERROR: An unexpected error occurred during processing.
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 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: INVALID_HEADER INVALID_METHOD MANDATORY_HEADER_NOT_PROVIDED FORMAT_ERROR MANDATORY_FIELD_NOT_PROVIDED INVALID_FIELD INTERNAL_SERVER_ERROR
Error Detail	O	String Max Length: 500	Detailed human readable text specific to this instance of the error. For example: Field `IBAN` must match `^[A-Z]\{2}[0-9]\{2}[A-Z0-9]\{1,30}$` and the IBAN checksum must be correct.
Error Instance	O	String Max Length: 256	The specific occurrence of an error generated during the processing of a VOP request. It allows each error in the CSV to be uniquely referenced and traced back to a particular transaction attempt.

* Man = Mandatory. Values: M = Mandatory, C = Conditional, O = Optional

CSV Plus

Field	Man*	Format	Description
E2E ID	M	String	This is the original unique end to end ID passed with the CSV 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.
Request 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}$`
Request Name	C	String Max Length: 140	The name of the Beneficiary: Mandatory for Natural Person. Optional for organisations. Usage Rule: If `name` is included, the `identification` fields cannot be used in the same request.
Request ID	C	String	Usage Rule: Only returned if provided in the original request.
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: MTCH: (Match): The name matches exactly with a record in the system – a confirmed match. CMTC: (Close Match): The name closely matches a record but may have slight differences, like spelling variations – a partial or approximate match. NMTC: (No Match): The name doesn't match any records in the system – no match found. NOAP: (Not Applicable): Verification check not possible, validation check is not applicable.
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: MTCH: (Match): The ID matches a record in the system - a confirmed match. NMTC: (No Match): The ID does not match any records - no match found. NOAP: (Not Applicable): The ID code is not supported or known by the Responding PSP - Verification check not possible, validation check is not applicable.
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: NP: Natual Person ORG: Organisation UNKNOWN: Not provided by the Responding PSP.
Account Status	C	Enum	The status of the account. Usage Rule: Only returned for VoP Plus. Possible Values: ACTIVE: a valid account and supported for checks. INACTIVE: a valid account marked by the Responding PSP as inactive. UNKNOWN: for an account that its status has been not known/provided by the Responding PSP.
Detailed Result	C	Enum	Additional information in case the matching result was not a match. Usage Rule: Only returned for VoP Plus. Possible Values: NAME_TOO_SHORT: the user only inputs a first name instead of a first name and surname. BANK_NOT_FOUND: the Responding PSP is not yet part of the VOP Scheme. OPTED_OUT: the account holder has opted out. ID_NOT_SUPPORTED: the provided partyIdentification type is not supported by the Responding PSP. NOT_FOUND: the account number was not found in the Responding PSP's records.
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: ACTIVE EXPIRED
New IBAN	C	String Max Length: 34	Usage Rule: Only returned if the Switching Service is enabled.
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: 400 - Bad request
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: FORMAT_ERROR: The request does not meet the required format or validation rules. INTERNAL_SERVER_ERROR: An unexpected error occurred during processing.
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 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: INVALID_HEADER INVALID_METHOD MANDATORY_HEADER_NOT_PROVIDED FORMAT_ERROR MANDATORY_FIELD_NOT_PROVIDED INVALID_FIELD INTERNAL_SERVER_ERROR
Error Detail	O	String Max Length: 500	Detailed human readable text specific to this instance of the error. For example: Field `IBAN` must match `^[A-Z]\{2}[0-9]\{2}[A-Z0-9]\{1,30}$` and the IBAN checksum must be correct.
Error Instance	O	String Max Length: 256	The specific occurrence of an error generated during the processing of a VOP request. It allows each error in the CSV to be uniquely referenced and traced back to a particular transaction attempt.

* Man = Mandatory. Values: M = Mandatory, C = Conditional, O = Optional