Skip to main content

CSV File Format (Response)

The CSV response file contains the outcome of multiple Confirmation of Payee checks, with each row representing an individual payee confirmation response.

Coming Soon!
  • Support for this file format is in development and coming soon!

Response File Guidance​

The guidance set out below is intended to ensure the response file can processed correctly by the receiving system;

  • The following file naming convention is used to ensure each response file downloaded is both unique and correlates with a corresponding request file.
    • file name starts with the prefix "cop_res" to identify this as a CoP Response file
    • file name includes your "company short name", agreed with your assigned Apicunia account manager during technical onboarding
    • file name includes the correlated date formatted as "yyyyMMdd", as was provided in the corresponding request file
    • file name includes the batch number, as was provided in the corresponding request file. Format: 3 digits starting 001 through to 999 ^(?!000)[0-9]{3}$
    • Provided format file name: "cop_res_companyshortname_yyyyMMdd_batchnumber.csv"
      • Example file name: "cop_res_bobsbank_20260901_001.csv"
  • Includes column headers in the file, as specified in the table below.
  • Uses only the specified data types for each column in the file, as specified in the table below.
  • Leading and trailing spaces are trimmed around all values.
  • Does not include empty/blank rows.
  • A comma (,) delimiter is used.
  • All headers and values are enclosed in quotation marks (" ").
  • The response file uses UTF-8 encoding.

Response File Structure​

The structure of the Response CSV file that is used is detailed in the table below.

Column (Header)Data TypeFormatRequiredDescription
CorrelationIdstringmax length: 100YesA unique value to track/trace each individual request within the file.
This could be a unique value from an external system (e.g. uuid, integer or another unique identifier)
RequestIdstringuuidYesThe Request ID of the CoP request, generated by and used by Apicunia, to obtain a confirmation of payee result from the responding PSP/RVM.
ResponseCodestringmax length: 20YesThe regulated CoP Response Code returned.
In the event the individual request returned an error, this will contain a machine readable problem details error code. See [here](/docs/overview/errors
ResponseDetailstringmax length: 4000ConditionalIf a Close Match is returned, this field contains the Matched Name.
In the event the individual request returned an error, this will contain the full standard problem detail (as JSON). See here

Sample Response File Structure​

Below is sample CSV response file detailing results for a mixure successful and failed CoP requests:

cop_res_bobsbank_20260827_001.csv
"correlationid","requestid","responsecode","responsedetail"
"1","660e8400-e29b-41d4-a716-446655440000","MTCH",""
"2","7ca7b810-9dad-41d1-80b4-00c04fd430c8","AC01","",
"3","g97ac10b-58cc-4372-a567-0e02b2c3d479","MBAM","Laura Savage"
"4","d2d2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e","BANM",""
"5","8c444840-9dc0-11d1-b245-5ffdce74fad2","ACNS",""
"6","448c7b6a-5d4e-43f2-a1b0-c9d8e7f6a5b4","BAMM","Oak Accounting"
"7","789e4567-e89b-42d3-a456-426614174000","PANM",""
"8","b6bb189e-8bf9-3888-9912-ace4e6543002","MTCH",""
"9","2e241101-e2bb-4255-8caf-4136c566a962","ANNM",""
"10","67f2c1d4-7e6a-4b3c-9d8e-5f4a3b2c1d0e","MTCH",""