Customer API

The Customer API is used to:

  • List all customer accounts.
  • Update existing customer accounts.
  • Create new customer accounts.

Get Customer Collection

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs()
Http Method GET
Http Request Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
Http Response Headers Content-Type: 'Application/atom+xml'
Content-Type: 'Application/hal+json'
Response Type Collection
Response

Get Customer Item

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs('CustomerCode')
Http Method GET
Http Request Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
Http Response Headers Content-Type: 'Application/atom+xml'
Content-Type: 'Application/hal+json'
Response Type Single Item
Response

Create New Customer

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs()/new
Http Method POST
Http Response Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
URL Parameters Optional: /verCustomerInputs()/new?CustomerCode='NumericValue'
Response Type Single Item with CustomerCode
Response

Data Parameters

  • Mnemonic
    Specifies an alternative easy means of referencing the Customer. For countries where the Customer name should not be recorded (e.g. numbered Customers/accounts) any value can be entered in this field with the exception that the first character must be alpha. Like the ID, the Mnemonic must be unique across T24. Care should be taken when assigning Mnemonics to Customers and some rules should ideally be defined across the bank to allow easy identification of the Customers by their Mnemonics. Note : For each Customer, the System will automatically update the internal file "MNEMONIC.CUSTOMER" which allows the User to display the Customers in Mnemonic sequence instead of Customer number. Validation Rules: 3-10 type MNE (Uppercase alpha or numeric, first character alpha, or ".") characters.
  • ShortName
    Identifies the name of the Customer in a more descriptive form, and will be used for on-line enrichments in any field where a Customer ID or Mnemonic has been input. For countries where the Customer name should not be recorded (e.g. numbered Customers/ Accounts) any valid SWIFT character can be entered in this field with the exception that all characters cannot be spaces. A clear and unique identification of the Customer must be entered in this field. When entering or displaying data where a Customer ID or Mnemonic is involved, the content of this field will be used as the enrichment of the Customer number/Mnemonic. Validation Rules: 3-35 type S (uppercase alpha or numeric) characters. Special Characters "&" and "/" are also allowed, with the exception that "/" cannot be entered as first character. If SHORT.NAME is reported in SWIFT Messages, the character "&" would be replaced with spaces. (Mandatory input)
  • Name1
    Identifies the name of the Customer, which can be used for correspondence. This field together with the following three fields form the address for the Customer. The SWIFT standard of 4 lines of 35 characters each has been chosen by T24. Only in the fields NAME 1 and STREET is input mandatory. The input to field STREET is non mandatory if the field STREET.NON.MANDAT is defined as 'Y', in the CUSTOMER.DEFAULT record whose ID is equal to the value of the SECTOR field. Where no other additional address has been defined in the DELIVERY file, the address defined in these four fields will be used on any correspondence sent to the Customer. After authorisation of the Customer record, this address will be automatically created in the DELIVERY file as the Address No. 1 and further maintenance of the Customer Address No. 1 will be performed directly in the Customer file. Any additional address to be opened or to be maintained will be done by means of the DELIVERY file. Validation Rules: 3-35 type S (uppercase alpha or numeric) characters. Special Characters "&" and "/" are also allowed, with the exception that "/" cannot be entered as first character. If NAME.1 is reported in SWIFT Messages, the character "&" would be replaced with spaces. (Mandatory input)
  • Sector
    Identifies the Sector code relating to the Customer. If the Sector code is defined on the Customer DEFAULT table the associated default values will be retrieved and added to a new Customer record during the Validation process except if some specific values have been input by the User. Validation Rules: 1-4 numeric character Sector code. (Mandatory input) It must be a valid code on the SECTOR table. The field must not be blank.
  • Gender
    Contains customer's gender. This additional client information is required by CRM. Validation Rules: Maximum of 6 characters is allowed Allowed values are MALE FEMALE
  • Title
    Holds the title for the customer name as the part of improved client information required by CRM A maximum of 6 characters may be entered. The following values are permitted: MR MRS MS MISS DR REV
  • GivenNames
    Specifies customer's given name. This additional client detail is required by CRM. Maximum of 50 character is allowed Characters must support swift format.

Validate Customer

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs('CustomerCode')/validate
Http Method POST
Http Request Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
Etag: 'returned by server'
Http Request Headers Content-Type: 'Application/atom+xml'
Content-Type: 'Application/hal+json'
If-Match: 'etag value'
Response

Authorise Customer

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs('CustomerCode')/authorise
Http Method POST
Http Request Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
Etag: 'returned by server'
Http Request Headers Content-Type: 'Application/atom+xml'
Content-Type: 'Application/hal+json'
If-Match: 'etag value'
Response

Update Existing Customer

URL http://127.0.0.1/Prospect-IRIS/Prospect.svc/GB0010001/verCustomerInputs('CustomerCode')
Http Method PUT
Http Request Headers Accept: 'Application/atom+xml'
Accept: 'Application/hal+json'
Etag: 'returned by server'
Http Request Headers Content-Type: 'Application/atom+xml'
Content-Type: 'Application/hal+json'
If-Match: 'etag value'
Response

Example


Add dependency in pom.xml
    <repositories>
      <repository>
        <id>mjangid</id>
        <name>iris-repo</name>
        <url>https://github.com/mjangid/iris-repo/raw/master/</url>
      </repository>
    </repositories>
    
    <dependencies>
      <dependency>
        <groupId>com.temenos.interaction</groupId>
        <artifactId>useragent-generic-java</artifactId>
        <version>0.10.0</version>
        <scope>compile</scope>
      </dependency>
    </dependencies>
JAVA code
import com.temenos.useragent.generic.DefaultInteractionSession;
import com.temenos.useragent.generic.InteractionSession;
import com.temenos.useragent.generic.mediatype.AtomPayloadHandler;

public class Customers { 
  public Boolean createCustomer(String dataServiceUrl) { 
    InteractionSession session = DefaultInteractionSession.newSession();
    session.registerHandler("application/atom+xml", AtomPayloadHandler.class)
           .basicAuth("INPUTT", "123456")
           .header("Content-Type", "application/atom+xml")
           .header("Accept", "application/atom+xml").url()
           .baseuri(dataServiceUrl)
           .path("verCustomerInputs()/new")
           .post();
           
    if (201 == session.result().code()) { 
      return true;
    } 
    
    return false; 
    } 
}

Example in Java Script

Java Script code