Skip to content

Bank Account Validation Integration Guide

This guide explains how to access GBGroup's Bank Account Validation web service product using their Identity Management Platform (IdM), available via SOAP web services. 

The fundamentals of integrating with the service are described here: Integration Fundamentals

Matchcode Validation Service 

The bank account validation service performs modulus checking of bank account numbers against sort codes.

This service can be used to check that an account number matches to a sortcode. Modulus checking can be applied to various activities, including allowing originators of transactions for the Bacs clearing service to write and use software that checks the possible validity of the account details quoted in their payment instructions before submission. Validating the sorting code and account details of these transactions has many benefits including helping to reduce the number of transactions that may be returned.

The Matchcode Validation Service products are available via the Identity Management ExecuteCapture web service method.

Global Bank Validation - Input Criteria


Method: ExecuteCapture

The ExecuteCapture method is used to access the Bank Account Validation product and services by specifying the corresponding profile.


Input Details

Type: ExecuteCaptureRequest

Field Name Type Description
securityHeader SecurityHeader The username used to access the system including domain name (e.g. user1@domainname.com)
profileRequest ProfileRequestCapture Details of the request


In the profileRequest element, the profileGuid should be specified as:

Profile  GUID
Bank Account Validation 39944560-4137-489A-A72D-64F0F3524B08

Bank Account Validation Criteria

The bank validation criteria should be entered into the IdMDataCaptureBank data structure (Note: both Sort Code and Account Number should be supplied together):

ExecuteCapture → ProfileRequestCapture → ProfileRequestCaptureData → IdMDataCaptureBank

Type: IdMDataCaptureBank

Field Name Type Description
accountNumber String Bank Account Number
sortcode String Bank Sortcode
Bank Input XML

The following XML sample demonstrates a request data object containing both an address and two bank accounts for validation.

<!-- request input data - bank account validation -->
  <req:requestdata>
     <req:address />
     <req:bank>
        <data:accountnumber>12345678</data:accountnumber>
        <data:sortcode>110167</data:sortcode>
     </req:bank>
     <req:filters tmp="?" />
     <req:options>
        <req:offset>0</req:offset>
        <req:maxreturn>10</req:maxreturn>
     </req:options>
     <req:additionaldata tmp="?" />
  </req:requestdata>

JSON sample:

{
    "customerreference": "test",
    "profileguid": "39944560-4137-489a-a72d-64f0f3524b08",
    "configurationid": "1",
    "requestdata": {
         "bank": [{
            "accountnumber": "12345678",
            "sortcode": "110167"
           }],
       "options": {
        "offset": "0",
        "maxreturn": "100",
      "countrycodeformat": "iso_3"
      }   
    }
}

Bank Output Format

The results of the GB Bank Account Web Service search are returned in a ProfileResponseDetails structure with a ProfileResponseDetails → responseType of 'VALIDATE'.

The ProfileResponseDetails structure contains a single ValidateResponse data structure which holds an array of ValidateResponseData records containing the returned validation data per input bank account details.

ExecuteCaptureResponse → ProfileResponse [0] → ProfileResponseDetails [0] → ValidateResponse → ValidateResponseData

The returned ValidateResponseData data structure is detailed below:

Type: ValidateResponseData

Field Name Type Description
input String The input Bank Account and Sortcode
status Enumeration SUCCESS if the validation has taken place, FAILURE otherwise
validityFlag Enumeration Overall validation result of the number (VALID, INVALID, UNKNOWN, UNSUPPORTED)
validationCodes IdmDataArrayAdditionalData Array of key value pairs containing the validation response codes for the input
Sample Output XML

The following output XML demonstrates the ProfileResponse for the bank component. The component name is Bank Account Validation and the response type is VALIDATE.

The validation results for each bank account will be returned in the same order as input. The array of ValidateResponse data structures contain the individual response details. The primary response value is validityFlag which dictates whether or not the account has been deemed to be valid or not. In addition a series of key value pair response codes are returned for each number, which contain data supplier specific summaries of the input.

<!-- bank account component response -->
<req:profileresponsedetails>
   <req:transactionguid>0e94d67e-621a-4ef2-96e4-a80bbffdd174</req:transactionguid>
   <req:componentname>bank account validation</req:componentname>
   <req:componentstatus>success</req:componentstatus>
   <req:componentaction>validate</req:componentaction>
   <req:responsetype>validate</req:responsetype>
   <req:notes>[]</req:notes>
 
 
 
   <!-- billing invoice -->
   <req:invoice>
      <req:invoicelist>
         <req:invoiceguid>cf315a7f-1e35-4020-8289-d42a2f6ec6d2</req:invoiceguid>
         <req:billinginformationguid>29938fbe-268c-4f3b-a395-ece3528fa375</req:billinginformationguid>
         <req:billingpoints>1</req:billingpoints>
         <req:datasetinvoices>
            <req:datasetcode>bankcheck</req:datasetcode>
            <req:billingpoints>1</req:billingpoints>
            <req:recordsreturned>1</req:recordsreturned>
            <req:datalicenceguid>29938fbe-268c-4f3b-a395-ece3528fa375</req:datalicenceguid>
         </req:datasetinvoices>
      </req:invoicelist>
   </req:invoice>
 
   <!-- response data -->
   <req:validateresponse>
      <req:resultstatus>verify</req:resultstatus>
      <req:recordsreturned>1</req:recordsreturned>
      <req:responsecount>1</req:responsecount>
 
      <!-- one response per account -->
      <req:response>
         <req:input>sortcode{number='110167'};bankaccountnumber{number='12345678'}</req:input>
         <req:status>success</req:status>
         <req:validityflag>valid</req:validityflag>
         <req:validationcodes>
            <data:item>
               <data:key>validationstatus</data:key>
               <data:value>incompatible</data:value>
            </data:item>
            <data:item>
               <data:key>isaccountnumbervalid</data:key>
               <data:value>true</data:value>
            </data:item>
            <data:item>
               <data:key>issortcodevalid</data:key>
               <data:value>true</data:value>
            </data:item>
            <data:item>
               <data:key>isaccountnumbervalidforsortcode</data:key>
               <data:value>false</data:value>
            </data:item>
            <data:item>
               <data:key>ismodulusentryfoundforsortcode</data:key>
               <data:value>true</data:value>
            </data:item>
            <data:item>
               <data:key>isbranchfoundforsortcode</data:key>
               <data:value>true</data:value>
            </data:item>
            <data:item>
               <data:key>bankname</data:key>
               <data:value>halifax</data:value>
            </data:item>
            <data:item>
               <data:key>branchname</data:key>
               <data:value>chelmsford high street</data:value>
            </data:item>
            <data:item>
               <data:key>addresstown</data:key>
               <data:value>leeds</data:value>
            </data:item>
            <data:item>
               <data:key>addresscounty</data:key>
               <data:value>west yorkshire</data:value>
            </data:item>
            <data:item>
               <data:key>addresspostcode</data:key>
               <data:value>ls19gg</data:value>
            </data:item>
            <data:item>
               <data:key>detailsbic</data:key>
               <data:value>hlfxgb21e30</data:value>
            </data:item>
            <data:item>
               <data:key>detailssub</data:key>
               <data:value>00</data:value>
            </data:item>
            <data:item>
               <data:key>detailsshorttitle</data:key>
               <data:value>chelmsford high street</data:value>
            </data:item>
            <data:item>
               <data:key>detailsshortname</data:key>
               <data:value>halifax</data:value>
            </data:item>
            <data:item>
               <data:key>detailsname</data:key>
               <data:value>halifax (a trading name of bank ofscotland plc)</data:value>
            </data:item>
            <data:item>
               <data:key>detailsbankcode</data:key>
               <data:value>0012</data:value>
            </data:item>
            <data:item>
               <data:key>detailsncbcode</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailssupervisorybody</data:key>
               <data:value>a</data:value>
            </data:item>
            <data:item>
               <data:key>detailsdeleteddate</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailslastchangedate</data:key>
               <data:value>28/05/2012</data:value>
            </data:item>
            <data:item>
               <data:key>detailsprintindicator</data:key>
               <data:value>0</data:value>
            </data:item>
            <data:item>
               <data:key>detailsbranchtype</data:key>
               <data:value>m</data:value>
            </data:item>
            <data:item>
               <data:key>detailsmainbranchsortcode</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailsmajorlocationname</data:key>
               <data:value>chelmsford</data:value>
            </data:item>
            <data:item>
               <data:key>detailsminorlocationname</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailsbranchname</data:key>
               <data:value>high street (c)</data:value>
            </data:item>
            <data:item>
               <data:key>detailssecondentry</data:key>
               <data:value>1</data:value>
            </data:item>
            <data:item>
               <data:key>detailssecondname</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailsfullbranchtitle</data:key>
               <data:value>chelmsford, high street (c)</data:value>
            </data:item>
            <data:item>
               <data:key>detailstel1</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>detailstel2</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>bacsstatus</data:key>
               <data:value>a</data:value>
            </data:item>
            <data:item>
               <data:key>bacsdatelastchanged</data:key>
               <data:value>06/06/2005</data:value>
            </data:item>
            <data:item>
               <data:key>bacsdateclosed</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>bacsredirectflag</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>bacsredirectsortcode</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>bacssettlementbank</data:key>
               <data:value>0008</data:value>
            </data:item>
            <data:item>
               <data:key>bacssettlementsection</data:key>
               <data:value>01</data:value>
            </data:item>
            <data:item>
               <data:key>bacssettlementsubsection</data:key>
               <data:value>00</data:value>
            </data:item>
            <data:item>
               <data:key>bacshandlingbank</data:key>
               <data:value>0008</data:value>
            </data:item>
            <data:item>
               <data:key>bacshandlingbankstream</data:key>
               <data:value>04</data:value>
            </data:item>
            <data:item>
               <data:key>bacsaccountsnumberedflag</data:key>
               <data:value>n</data:value>
            </data:item>
            <data:item>
               <data:key>bacsddivoucherflag</data:key>
               <data:value>n</data:value>
            </data:item>
            <data:item>
               <data:key>bacstransactionsdisallowed</data:key>
               <data:value>cu</data:value>
            </data:item>
            <data:item>
               <data:key>candccstatus</data:key>
               <data:value>f</data:value>
            </data:item>
            <data:item>
               <data:key>candccdatelastchange</data:key>
               <data:value>28/05/2012</data:value>
            </data:item>
            <data:item>
               <data:key>candccdateclosed</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>candccsettlementbank</data:key>
               <data:value>8</data:value>
            </data:item>
            <data:item>
               <data:key>candccdebitagencysortcode</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>candccreturnindicator</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>candccgbniindicator</data:key>
               <data:value>gb</data:value>
            </data:item>
            <data:item>
               <data:key>chapsreturnindicator</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>chapsstatus</data:key>
               <data:value>i</data:value>
            </data:item>
            <data:item>
               <data:key>chapsdatelastchange</data:key>
               <data:value>22/12/2003</data:value>
            </data:item>
            <data:item>
               <data:key>chapsdateclosed</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>chapssettlementmember</data:key>
               <data:value>008</data:value>
            </data:item>
            <data:item>
               <data:key>chapsroutingbic</data:key>
               <data:value>bofsgb3exxx</data:value>
            </data:item>
            <data:item>
               <data:key>fasterstatus</data:key>
               <data:value>a</data:value>
            </data:item>
            <data:item>
               <data:key>fasterdatelastchange</data:key>
               <data:value>12/09/2011</data:value>
            </data:item>
            <data:item>
               <data:key>fasterdateclosed</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>fasterredirectflag</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>fasterredirectsortcode</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>fastersettlementbanktype</data:key>
               <data:value>01</data:value>
            </data:item>
            <data:item>
               <data:key>fastersettlementbankcode</data:key>
               <data:value>0004</data:value>
            </data:item>
            <data:item>
               <data:key>fasterconnectiontype</data:key>
               <data:value>01</data:value>
            </data:item>
            <data:item>
               <data:key>fasterbankcode</data:key>
               <data:value>0004</data:value>
            </data:item>
            <data:item>
               <data:key>fasteraccountsnumberedflag</data:key>
               <data:value>n</data:value>
            </data:item>
            <data:item>
               <data:key>fasteragencytype</data:key>
               <data:value>i</data:value>
            </data:item>
            <data:item>
               <data:key>addressline1</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>addressline2</data:key>
               <data:value>p o box 722</data:value>
            </data:item>
            <data:item>
               <data:key>addressline3</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>addressline4</data:key>
               <data:value/>
            </data:item>
            <data:item>
               <data:key>sortcode</data:key>
               <data:value>110167</data:value>
            </data:item>
            <data:item>
               <data:key>address</data:key>
               <data:value>p o box 722, leeds, west yorkshire, ls19gg</data:value>
            </data:item>
         </req:validationcodes>
      </req:response>
   </req:validateresponse>
</req:profileresponsedetail>
{
   "profileheader":    {
      "profileguid": "39944560-4137-489a-a72d-64f0f3524b08",
      "profilename": "bank account validation",
      "transactionguid": "b7cd6412-17a5-41ef-82fd-6b0049570556",
      "transactiontimestamp": 1433169119260,
      "profilestatus": "success",
      "remarks": null
   },
   "profileresponsedetails": [   {
      "transactionguid": "7ca55488-7e15-4842-b68c-67d81d3e7cc7",
      "componentname": "bank account validation",
      "componentstatus": "success",
      "componentaction": "validate",
      "responsetype": "validate",
      "notes": "[]",
      "invoice":       {
         "invoicelist": [         {
            "invoiceguid": "d2977bb6-2ff6-4432-a7e5-5a9738b57ff5",
            "billinginformationguid": "a701cc55-0220-4524-85cd-31a6f2f7aaa6",
            "datalicencedescription": null,
            "billingpoints": 1,
            "creditsused": 1,
            "datasetinvoices": [            {
               "datasetcode": "bankcheck",
               "billingpoints": 1,
               "recordsreturned": 1,
               "datalicenceguid": "a701cc55-0220-4524-85cd-31a6f2f7aaa6"
            }]
         }],
         "tmp": null
      },
      "captureresponse": null,
      "validateresponse":       {
         "resultstatus": "verify",
         "recordsreturned": 1,
         "responsecount": 1,
         "response": [         {
            "input": "sortcode{number='110167'};bankaccountnumber{number='12345678'}",
            "status": "success",
            "validityflag": "valid",
            "validationcodes":             {
               "item":                [
                                    {
                     "key": "validationstatus",
                     "value": "incompatible"
                  },
                                    {
                     "key": "isaccountnumbervalid",
                     "value": "true"
                  },
                                    {
                     "key": "issortcodevalid",
                     "value": "true"
                  },
                                    {
                     "key": "isaccountnumbervalidforsortcode",
                     "value": "false"
                  },
                                    {
                     "key": "ismodulusentryfoundforsortcode",
                     "value": "true"
                  },
                                    {
                     "key": "isbranchfoundforsortcode",
                     "value": "true"
                  },
                                    {
                     "key": "bankname",
                     "value": "halifax"
                  },
                                    {
                     "key": "branchname",
                     "value": "chelmsford high street"
                  },
                                    {
                     "key": "addresstown",
                     "value": "leeds"
                  },
                                    {
                     "key": "addresscounty",
                     "value": "west yorkshire"
                  },
                                    {
                     "key": "addresspostcode",
                     "value": "ls19gg"
                  },
                                    {
                     "key": "detailsbic",
                     "value": "hlfxgb21e30"
                  },
                                    {
                     "key": "detailssub",
                     "value": "00"
                  },
                                    {
                     "key": "detailsshorttitle",
                     "value": "chelmsford high street"
                  },
                                    {
                     "key": "detailsshortname",
                     "value": "halifax"
                  },
                                    {
                     "key": "detailsname",
                     "value": "halifax (a trading name of bank ofscotland plc)"
                  },
                                    {
                     "key": "detailsbankcode",
                     "value": "0012"
                  },
                                    {
                     "key": "detailsncbcode",
                     "value": ""
                  },
                                    {
                     "key": "detailssupervisorybody",
                     "value": "a"
                  },
                                    {
                     "key": "detailsdeleteddate",
                     "value": ""
                  },
                                    {
                     "key": "detailslastchangedate",
                     "value": "28/05/2012"
                  },
                                    {
                     "key": "detailsprintindicator",
                     "value": "0"
                  },
                                    {
                     "key": "detailsbranchtype",
                     "value": "m"
                  },
                                    {
                     "key": "detailsmainbranchsortcode",
                     "value": ""
                  },
                                    {
                     "key": "detailsmajorlocationname",
                     "value": "chelmsford"
                  },
                                    {
                     "key": "detailsminorlocationname",
                     "value": ""
                  },
                                    {
                     "key": "detailsbranchname",
                     "value": "high street (c)"
                  },
                                    {
                     "key": "detailssecondentry",
                     "value": "1"
                  },
                                    {
                     "key": "detailssecondname",
                     "value": ""
                  },
                                    {
                     "key": "detailsfullbranchtitle",
                     "value": "chelmsford, high street (c)"
                  },
                                    {
                     "key": "detailstel1",
                     "value": ""
                  },
                                    {
                     "key": "detailstel2",
                     "value": ""
                  },
                                    {
                     "key": "bacsstatus",
                     "value": "a"
                  },
                                    {
                     "key": "bacsdatelastchanged",
                     "value": "06/06/2005"
                  },
                                    {
                     "key": "bacsdateclosed",
                     "value": ""
                  },
                                    {
                     "key": "bacsredirectflag",
                     "value": ""
                  },
                                    {
                     "key": "bacsredirectsortcode",
                     "value": ""
                  },
                                    {
                     "key": "bacssettlementbank",
                     "value": "0008"
                  },
                                    {
                     "key": "bacssettlementsection",
                     "value": "01"
                  },
                                    {
                     "key": "bacssettlementsubsection",
                     "value": "00"
                  },
                                    {
                     "key": "bacshandlingbank",
                     "value": "0008"
                  },
                                    {
                     "key": "bacshandlingbankstream",
                     "value": "04"
                  },
                                    {
                     "key": "bacsaccountsnumberedflag",
                     "value": "n"
                  },
                                    {
                     "key": "bacsddivoucherflag",
                     "value": "n"
                  },
                                    {
                     "key": "bacstransactionsdisallowed",
                     "value": "cu"
                  },
                                    {
                     "key": "candccstatus",
                     "value": "f"
                  },
                                    {
                     "key": "candccdatelastchange",
                     "value": "28/05/2012"
                  },
                                    {
                     "key": "candccdateclosed",
                     "value": ""
                  },
                                    {
                     "key": "candccsettlementbank",
                     "value": "8"
                  },
                                    {
                     "key": "candccdebitagencysortcode",
                     "value": ""
                  },
                                    {
                     "key": "candccreturnindicator",
                     "value": ""
                  },
                                    {
                     "key": "candccgbniindicator",
                     "value": "gb"
                  },
                                    {
                     "key": "chapsreturnindicator",
                     "value": ""
                  },
                                    {
                     "key": "chapsstatus",
                     "value": "i"
                  },
                                    {
                     "key": "chapsdatelastchange",
                     "value": "22/12/2003"
                  },
                                    {
                     "key": "chapsdateclosed",
                     "value": ""
                  },
                                    {
                     "key": "chapssettlementmember",
                     "value": "008"
                  },
                                    {
                     "key": "chapsroutingbic",
                     "value": "bofsgb3exxx"
                  },
                                    {
                     "key": "fasterstatus",
                     "value": "a"
                  },
                                    {
                     "key": "fasterdatelastchange",
                     "value": "12/09/2011"
                  },
                                    {
                     "key": "fasterdateclosed",
                     "value": ""
                  },
                                    {
                     "key": "fasterredirectflag",
                     "value": ""
                  },
                                    {
                     "key": "fasterredirectsortcode",
                     "value": ""
                  },
                                    {
                     "key": "fastersettlementbanktype",
                     "value": "01"
                  },
                                    {
                     "key": "fastersettlementbankcode",
                     "value": "0004"
                  },
                                    {
                     "key": "fasterconnectiontype",
                     "value": "01"
                  },
                                    {
                     "key": "fasterbankcode",
                     "value": "0004"
                  },
                                    {
                     "key": "fasteraccountsnumberedflag",
                     "value": "n"
                  },
                                    {
                     "key": "fasteragencytype",
                     "value": "i"
                  },
                                    {
                     "key": "addressline1",
                     "value": ""
                  },
                                    {
                     "key": "addressline2",
                     "value": "p o box 722"
                  },
                                    {
                     "key": "addressline3",
                     "value": ""
                  },
                                    {
                     "key": "addressline4",
                     "value": ""
                  },
                                    {
                     "key": "sortcode",
                     "value": "110167"
                  },
                                    {
                     "key": "address",
                     "value": "p o box 722, leeds, west yorkshire, ls19gg"
                  }
               ],
               "tmp": null
            }
         }]
      },
      "verifyresponse": null,
      "traceresponse": null
   }]
}
Detailed Bank Responses
Name Description
ValidationStatus Validation of Request(UNKNOWN / OK / EMPTY_PARAMETER / EMPTY_SORTCODE / EMPTY_ACCOUNTNUMBER / INVALID_SORTCODE / INVALID_ACCOUNTNUMBER / INCOMPATIBLE / INTERNAL_ERROR / SORTCODE_NOT_FOUND / FOREIGN_CURRENCY_ACCOUNT)
IsAccountNumberValid Account number validation status (true/false)
IsSortCodeValid Sortcode validation status (true/false)
IsAccountNumberValidForSortCode Is the Account number valid with the supplied Sortcode (true/false)
Sortcode Branch Sortcode
BankName Bank Name
BranchName Branch Name
Address The Full address formatted in one field
AddressLine1 The first line of the Full address
AddressLine2 The second line of the Full address
AddressLine3 The third line of the Full address
AddressLine4 The fourth line of the Full address
AddressTown Town Branch is located in
AddressCounty County Branch is located in
AddressPostCode Branch Postcode
DetailsBranchName The Branch name for requested Sortcode
DetailsSecondEntry Will be 1 or 2.
DetailsFullBranchTitle This is an extended title for the bank office. If the institution does not provide a full branch title, the details in DetailsShortTitle will be copied here.
DetailsTel1 Telephone Number of Branch
DetailsTel2 Alternative Telephone Number of Branch
DetailsSub Subbranch Title
DetailsShortTitle Short Branch Title as appears on cheque books
DetailsShortName short name of owning bank as approved by Payments Council
DetailsBankCode Numeric Bank code of Owning bank as allocated by Vocalink
DetailsNCBCode National Central Bank Country Code
DetailsSupervisoryBody For bank offices that are agencies in one or more of the clearings, specifies the authorising body. Will be either:
A : for PRA/FCA
B : for other financial authorities
C : for Jersey, Guernsey or Isle of Man
D : for Other.
DetailsDeletedDate When a bank office is closed in all services it is removed from the ISCD. This field shows the date the bank office will be deleted from the ISCD
DetailsLastChangeDate Will be the date the last amendment was made to any of the clearing groups or the other general information group
DetailsPrintIndicator Print Indicator 0 to 5
DetailsBranchType M : Bank office is a main bank office
S : Bank office is a subbank office Same sorting code as the main bank office but with a subbank office suffix
L : Bank office is a linked bank office Linked to a main bank office with different sorting code
DetailsMainBranchSortCode If the branch type indicator is set to L, will be the sorting code of the bank office this bank office is linked to
DetailsMajorLocationName Principally, these are the Post Office postal districts eg MANCHESTER, LONDON. VocaLink maintains a table of major locations.
DetailsMinorLocationName These can be any values.
BACSStatus M : Bank office of Bacs member, accepts Bacs payments A : Bank office of agency bank, accepts Bacs payments N : Bank office does not accept Bacs payments
BACSDateLastChanged Will be the effective date of the last amendment made to this data group (ie the bank office's Bacs information).
BACSDateClosed Will be the date the bank office will be closed in the Bacs clearing. The date will be set at the same time as the status is set to N.
BACSRedirectFlag If the bank office is set as the redirection sorting code for one or more other bank offices, will be set to R. Otherwise, the field will be blank.
BACSRedirectSortCode If appropriate the six-digit sorting code to which output destined for this sorting code will be redirected
BACSSettlementBank Will be the numeric, VocaLink generated, bank code of the Bacs member that settles the Bacs output for this sorting code. For Bacs members this will be the same as DetailsBankCode For agencies in Bacs this will be the bank code of one of the Bacs members.
BACSSettlementSection Data required for Bacs output and settlement, specified by the Bacs member
BACSSettlementSubSection Data required for Bacs output and settlement, specified by the Bacs member
BACSHandlingBank Will be the numeric, VocaLink generated, bank code of the Bacs member that handles the Bacs output for this bank office.
BACSHandlingBankStream Each Bacs member can divide its output into one or more streams.
This will be the numeric code of the output stream specified, by the handling bank, for output destined for this bank office.
BACSAccountsNumberedFLag Account numbered flag:
Y : Bank office has transferable account numbers On redirection due to branch closure the account number is not zeroised. N : Bank office does not transferable account numbers On redirection due to branch closure the account number is zeroised.
BACSdDIVoucherFlag Will be either:
Y : Bank office cannot accept output of electronic DDIs Requires printed vouchers N : Bank office can accept output of electronic DDIs Does not require printed vouchers.
BACSTransactionsDisallowed Will be DR if the bank office cannot accept DR transaction types
Will be CR if the bank office cannot accept CR transaction types
Will be CU if the bank office cannot accept CU transaction types
Will be BS if the bank office cannot accept BS transaction types
Will be DV if the bank office cannot accept DV transaction types
Will be AU if the bank office cannot accept AU transaction types
CAndCCStatus M : Bank office of a C&CC member
F : Bank office of a full agency bank
D : Bank office of a debit agency bank
N : Bank office is not part of C&CC clearing
CAndCCDateLastChange Will be the effective date of the last amendment made to this data group (ie the bank office's C&CC information).
CAndCCDateClosed Will be the date the bank office will be closed in the C&CC clearing. The date will be set at the same time as the status is set to N.
CAndCCSettlementBank VocaLink generated, bank code of the C&CC member that settles the C&CC output for this bank office. For C&CC members this will be the same as field 9. For agencies in C&CC this will be the bank code of one of the C&CC members
CAndCCDebitAgencySortCode If the status is set to D, will be the sorting code of the bank office that handles cheque clearing for this bank office. Otherwise will be blank.
CAndCCReturnIndicator Return Indicator
CAndCCGBNIIndicator For C&CC purposes, this field identifies whether an office is in mainland Great Britain (GB) or Northern Ireland (NI). This field may be blank.
CHAPSReturnIndicator R : If the bank office is the nominated return office
The office to which returned CHAPS Sterling payments should be sent
CHapsStatus D : Bank office is a direct office of a CHAPS member that accepts CHAPS Sterling payments
I : Bank office is an indirect office of a CHAPS member or agency bank that accepts CHAPS Sterling payments
N : Bank office does not accept CHAPS Sterling payments
Note: a direct office is bank office that is part of the SWIFT closed user group.
CHAPSDateLastChange Will be the effective date of the last amendment made to this data group (ie the bank office's CHAPS Sterling information).
CHAPSDateClosed Will be the date the bank office will be closed in the CHAPS Sterling clearing. The date will be set at the same time as the status is set to N.
CHAPSSettlementMember Will be the numeric CHAPS ID of the CHAPS Sterling member that settles the CHAPS Sterling payments for this bank office. For CHAPS Sterling members this will be the same as field 9. For agencies in CHAPS Sterling this will be the bank code of one of the CHAPS Sterling members.
Note: this is not the BACS bank code. It is a numeric code used in both CHAPS clearings, and the first digit is always zero.
CHAPSRoutingBic Specifies the SWIFT closed user group to which CHAPS Sterling payments for this bank office should be routed.
FasterStatus M : Bank office of FPS member, accepts FPS payments
A : Bank office of FPS agency bank, accepts FPS payments
N : Bank office does not accept FPS payments. S
FasterDateLastChange Will be the effective date of the last amendment made to this data group (ie the bank office's Faster Payments information).
FasterDateClosed Will be the date the bank office will be closed in the Faster Payments clearing. The status will be set to N when date closed is effective.
FasterRedirectFlag If the bank office is set as the redirection sorting code for one or more bank offices, will be set to R.
FasterRedirectSortCode The six-digit sorting code to which output destined for this sorting code will be redirected
FasterSettlementBankType Will be a two-digit connectivity code. Will be 01 (FPS member).
FasterSettlementBankCode Will be the bank code of the FPS member that settles the Faster Payments output for this sorting code.
FasterConnectionType Will be a two-digit connectivity code, either:
01 : FPS member
02 : Direct agency
04 : Responding third party beneficiary
05 : Nonresponding third party beneficiary
FasterBankCode Will be the bank code of the FPS member, agency or third party beneficiary that the Faster Payments routed payment will be sent to.
FasterAccountsNumberedFlag Y : Bank office has transferable account numbers On redirection due to branch closure the account number is not zeroised.
N : Bank office does not transferable account numbers On redirection due to branch closure the account number is zeroised.
FasterAgencyType Mandatory when status equals A. Will be either:
D : Bank office is a direct agency FPS payment requests are sent directly to the agency
I : Bank office is an indirect agency FPS payment requests are sent via an intermediary bank. The intermediary bank can be either an FPS member or a direct agency, that is handling bank connection type 01 or 02 respectively.

Error Information

Information on possible error codes is given here: Error Code Information

Get started for free today

  • No credit card required
  • Cancel any time
  • 24/5 support
Get started