getFpsDetail
 
SOAP API > Validating Payments > Bank Account Numbers > United Kingdom Functions >
 

getFpsDetails

Get Faster Payments Service Details
A United Kingdom specific function that returns information specific to the UK Faster Payments service for a given bank branch.

Syntax:

fps responseObject = getFpsDetails(string keycode, string sortcode)

Notes:

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 getFpsDetails to return FPS specific information.

Returned data

An returned object (an instance of fps ) containing the following members:

 

 Name  Description
 fpsStatus Faster Payments Service (FPS) status:

Will be either:

  • 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. See fpsDateClosed
 fpsReserved

 Reserved for future use.
 

 fpsDateLastChanged Will be the effective date of the last amendment made to this data group (ie the bank office’s Faster Payments information).
 fpsDateClosed

Will be the date the bank office will be closed in the Faster Payments clearing. The status (fpsStatus) will be set to N when date closed is effective.

 fpsRedirectionFromFlag

If the bank office is set as the redirection sorting code for one or more bank offices, will be set to R. Otherwise will be blank.

 fpsRedirectionToSortcode

Will be either:

  • The six-digit sorting code to which output destined for this sorting code will be redirected
  • Blank
 fpsSettlementBankConnectionType

Will be a two-digit connectivity code. Will be 01 (FPS member).


 fpsSettlementBankCode

 

Will be the bank code of the FPS member that settles the Faster Payments output for this sorting code.

 fpsSettlementBankName

 

Will be the bank (long) name of the FPS member that settles the Faster Payments output for this sorting code.

 fpsHandlingBankConnectionCode

Will be a two-digit connectivity code, either:

  • 01 FPS member
  • 02 Direct agency
  • 04 Responding third party beneficiary
  • 05 Nonresponding third party beneficiary.

 fpsHandlingBankCode

 

Will be the bank code of the FPS member, agency or third party beneficiary that the Faster Payments routed payment will be sent to.

 fpsHandlingBankName

 

Will be the (long) name of the FPS member, agency or third party beneficiary that the Faster Payments routed payment will be sent to.

 fpsAccountsNumberedFlag

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.

 fpsAgencyType

Mandatory when status (fpsStatus) 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.

 

 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 getFpsDetails function using c#.
As with all examples, please see the section Adding a reference to the Validate Web Service .

c# Example

using System;
namespace getFpsDetails
{
  class Program
  {
    static void Main(string[] args)
    {

      // Define strings for the keycode and the sort code get Faster Payments 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 getFpsDetails method
      validate.fps fpsObject = wsObject.getFpsDetails(keycode, sortcode);

      // now we have an object 'fpsObject' containing all of the 
      //fps information for the branch with sort code 404113
      Console.WriteLine(fpsObject.fpsStatus);
      Console.WriteLine(fpsObject.fpsHandlingBankName);
      Console.WriteLine(fpsObject.errorCode);
      Console.WriteLine(fpsObject.errorText);
      Console.ReadLine();
    }
  }
}

 

Visual Basic .net
The following sample show how to use the getFpsDetails function using Visual Basic.net.
As with all examaples, 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 fps object for the returning data
    Dim fpsObject As validate.fps

    '  Call the web service function - getFpsDetails
    fpsObject = wsobject.getFpsDetails(keycode, sortcode)

    ' display the returned information - or error message
    Console.WriteLine("FPS Status: " & fpsObject.fpsStatus)
    Console.WriteLine("Handling Bank: " & fpsObject.fpsHandlingBankName)
    Console.WriteLine(fpsObject.errorCode)
    Console.WriteLine(fpsObject.errorText)
    Console.ReadLine()
 
End Sub
End Module

 

Java
The following sample show how to use the getFpsDetails function using Java.

Java Example

package getfpsdetails;

public class Main {

    public static void main(String[] args) {

        com.bemac.vtest.Validate service = new com.bemac.vtest.Validate();
        com.bemac.vtest.ValidateSoap port = service.getValidateSoap12();
  
        java.lang.String keyCode = "qwerty";
        java.lang.String sortcode = "404113";

        com.bemac.vtest.Fps result = port.getFpsDetails(keyCode, sortcode);
        System.out.println("Result = " +result.getFpsStatus()); 
        System.out.println("Result = " +result.getFpsHandlingBankName());
        System.out.println( "Error Code = " +result.getErrorCode());
        System.out.println( "Error Message = " +result.getErrorText());
    }
}

XML Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:vtes="http://vtest.bemac.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <vtes:getFpsDetails>
         <vtes:keyCode>qwerty</vtes:keyCode>
         <vtes:sortcode>404113</vtes:sortcode>
      </vtes:getFpsDetails>
   </soapenv:Body>
</soapenv:Envelope>

 

XML Response

Below is a typical XML message response from using getFpsDetails(). 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <getFpsDetailsResponse xmlns="http://vtest.bemac.com/">
         <getFpsDetailsResult>
            <fpsStatus>M</fpsStatus>
            <fpsDateLastChanged>23/02/2008</fpsDateLastChanged>
            <fpsSettlementBankConnectionType>01</fpsSettlementBankConnectionType>
            <fpsSettlementBankCode>0005</fpsSettlementBankCode>
            <fpsSettlementBankName>HSBC Bank Plc</fpsSettlementBankName>
            <fpsHandlingBankConnectionCode>01</fpsHandlingBankConnectionCode>
            <fpsHandlingBankCode>0005</fpsHandlingBankCode>
            <fpsHandlingBankName>HSBC Bank Plc</fpsHandlingBankName>
            <fpsAccountsNumberedFlag>Y</fpsAccountsNumberedFlag>
         </getFpsDetailsResult>
      </getFpsDetailsResponse>
   </soap:Body>
</soap:Envelope>

 

 


 

 

 ©Copyright 2023 Paygate Solutions Limited