getChapSEDetails
 
SOAP API > Validating Payments > Bank Account Numbers > United Kingdom Functions >
getChapsEDetails

A United Kingdom specific function that returns information specific to the CHAPS Euro service for a given bank branch.

Syntax:

getChapsEDetails(string keycode, string sortcode)


 Notes:

getChapsEDetails returns details or information use specifically for CHAPS Euro payments. The function can be used to determine that:

  • The branch accepts CHAPS Euro payments directly, indirectly or does not participate in the CHAPS Euro Payment scheme
  • The routing BIC is the branch accepts CHAPS Euro payments indirectly
  • The CHAPS Euro ID
  • The real-time gross settlement (RTGS) indicator and the Target status.

 

This function is normally used in conjunction with validateAccount(). First use validateAccount to ensure the account number and sort code are valid and then use getChapsEDetails to return CHAPS Euro specific information.


Returned data

An object chapse, c ontaining the following:

 

 

 Name  Description
 chapseStatus CHAPS Euro service status:

D – Bank office is a direct office that accepts CHAPS Euro payments
I – Bank office is an indirect office that accepts CHAPS Euro payments
N – Bank office does not participate in CHAPS Euro; does not accept CHAPS Euro payments.
 chapseDateLastChanged The date that the details of the bank office’s participation in the CHAPS Euro clearing was amended. (Note: Removal of the bank office’s participation in CHAPS Euro is not considered an amendment for the purpose of this field.)
 chapseDateClosed The date from which the bank office will no longer participate in the CHAPS Euro service.
 chapseRoutingBICBank The direct BIC to which CHAPS Euro payments for this bank office should be routed.
 chapseRoutingBICBranch The direct BIC to which CHAPS Euro payments for this bank office should be routed.
 chapseCHAPSEuroID The CHAPS code of the CHAPS Euro scheme member that settles the CHAPS Euro payments for this bank office.
 chapseReturnIndicator If R, the bank office is the office to which returned CHAPS Euro payments should be sent.
 chapseRTGSIndicatorTargetStatus The real-time gross settlement (RTGS) indicator and the Target status separated by a /.

The RTGS indicator will be Y if CHAPS Euro is the preferred RTGS system to be used for payments to this bank office; otherwise, will be N.

The Target status will be CHP if the owning bank of the bank office is a CHAPS Euro scheme member and the country code part of the BIC is GB; otherwise will be CH+.
 errorCode If an error occurs during processing the error number will be here. See the error section for more details.
 errorText If an error occurs during processing the error textually description will be here. See the error section for more details.

 

 

 

Supported Versions

Validate Web Service Version 1.x


Errors

 


Example Code

c#
The following sample show how to use the getChapsEObject function using c#.
As with all examples, please see the section Adding a reference to the Validate Web Service .

c# Example 1

      validate.validate wsObject = new validate.validate();
      validate.chapse chapsEObject = wsObject.getChapSEDetails("qwerty", "404113");
 

 

c# Example 2

using System;
using
System.Collections.Generic;
using
System.Text;
namespace
getChapsEDetails
{
  class
Program
  {
    static void Main(string
[] args)
    {

      // Define strings for the keycode and the sort code get BACS details for.
      string keycode = "qwerty"
;
      string sortcode = "404113"
;

      // Set up a web service object
      validate.validate wsObject = new validate.validate
();

      // make the call to the Validate getChapsEDetails method
      validate.chapse
chapsEObject = wsObject.getChapSEDetails(keycode, sortcode);

      // now we have an object 'chapsEObject' containing all of the 
      // Chaps Euro information for the branch with sort code 404113
      Console
.WriteLine(chapsEObject.chapseStatus);
      Console
.WriteLine(chapsEObject.chapseCHAPSEuroID);
      Console
.WriteLine(chapsEObject.errorCode);
      Console
.WriteLine(chapsEObject.errorText);
      Console
.ReadLine();
    }
  }
}

 

Visual Basic .net
The following sample show how to use the getChapsEDetails function using Visual Basic.net.
As with all examples, please see the section Adding a reference to the Validate Web Service .

 

Visual Basic.net Example

Module Module1
  Sub Main()

    ' define the keycode and sortcode
    Dim keycode As String = "qwerty"
    Dim sortcode As String = "404113"

    ' Create a web service object
    Dim wsobject As New validate.validate()

    ' create a chaps object for the returning data
    Dim chapsEObject As validate.chapse

    ' Call the web service function - getBacsDetails
    chapsEObject = wsobject.getChapSEDetails(keycode, sortcode)

    ' display the returned information - or error message
    Console.WriteLine("HAPS Euro Status: " & chapsEObject.chapseStatus)
    Console.WriteLine(
"CHAPS Euro ID: " & chapsEObject.chapseCHAPSEuroID)
    Console.WriteLine(chapsEObject.errorCode)
    Console.WriteLine(chapsEObject.errorText)
    Console.ReadLine()

  End Sub
End
Module

 

Java
The following sample show how to use the getChapsEDetails function using Java

Java

package getchapsedetails;
public class Main {

    public static void main(String[] args) {
               
        validate.Validate service = new validate.Validate();
        validate.ValidateSoap port = service.getValidateSoap12();

        java.lang.String keyCode = "qwerty" ;
        java.lang.String sortcode = "404113" ;

        validate.Chapse result = port.getChapSEDetails(keyCode, sortcode);
        System.out.println( "Status = " +result.getChapseStatus());
        System.out.println( "Euro ID Flag = " +result.getChapseCHAPSEuroID());
        System.out.println( "Error Code = " +result.getErrorCode());
        System.out.println( "Error Message = " +result.getErrorText());
    }

}

 

 

 

 

 

 

 

 

 

 


 


 

 ©Copyright 2023 Paygate Solutions Limited