Services Web Service

Services

Click here for a complete list of operations.

getClient

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Services.asmx HTTP/1.1
Host: services.tranzgate.com.ng
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.tranzgate.com.ng/getClient"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getClient xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <clientNo>string</clientNo>
    </getClient>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getClientResponse xmlns="https://services.tranzgate.com.ng/">
      <getClientResult>
        <ClientID>string</ClientID>
        <ClientName>string</ClientName>
        <UsesSession>boolean</UsesSession>
        <CustomerIDLabel>string</CustomerIDLabel>
        <UsesFeeService>boolean</UsesFeeService>
        <UsesPaymentPostingService>boolean</UsesPaymentPostingService>
        <UsesPaymentCancellationService>boolean</UsesPaymentCancellationService>
        <AdministrativeFeePaymentCode>string</AdministrativeFeePaymentCode>
        <TranzgateFeePaymentCode>string</TranzgateFeePaymentCode>
        <FinancialInstitutionFeePaymentCode>string</FinancialInstitutionFeePaymentCode>
        <UsesCustomerInfoService>boolean</UsesCustomerInfoService>
        <UsePreRegisteredCustomersOnly>boolean</UsePreRegisteredCustomersOnly>
        <ClientPaysInstitutionFee>boolean</ClientPaysInstitutionFee>
        <ClientPaysTranzgateFee>boolean</ClientPaysTranzgateFee>
        <ClientPaysAdministrativeFee>boolean</ClientPaysAdministrativeFee>
        <UsesFeeCreationService>boolean</UsesFeeCreationService>
        <UserCanChangeSwitch>boolean</UserCanChangeSwitch>
      </getClientResult>
    </getClientResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Services.asmx HTTP/1.1
Host: services.tranzgate.com.ng
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getClient xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <clientNo>string</clientNo>
    </getClient>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getClientResponse xmlns="https://services.tranzgate.com.ng/">
      <getClientResult>
        <ClientID>string</ClientID>
        <ClientName>string</ClientName>
        <UsesSession>boolean</UsesSession>
        <CustomerIDLabel>string</CustomerIDLabel>
        <UsesFeeService>boolean</UsesFeeService>
        <UsesPaymentPostingService>boolean</UsesPaymentPostingService>
        <UsesPaymentCancellationService>boolean</UsesPaymentCancellationService>
        <AdministrativeFeePaymentCode>string</AdministrativeFeePaymentCode>
        <TranzgateFeePaymentCode>string</TranzgateFeePaymentCode>
        <FinancialInstitutionFeePaymentCode>string</FinancialInstitutionFeePaymentCode>
        <UsesCustomerInfoService>boolean</UsesCustomerInfoService>
        <UsePreRegisteredCustomersOnly>boolean</UsePreRegisteredCustomersOnly>
        <ClientPaysInstitutionFee>boolean</ClientPaysInstitutionFee>
        <ClientPaysTranzgateFee>boolean</ClientPaysTranzgateFee>
        <ClientPaysAdministrativeFee>boolean</ClientPaysAdministrativeFee>
        <UsesFeeCreationService>boolean</UsesFeeCreationService>
        <UserCanChangeSwitch>boolean</UserCanChangeSwitch>
      </getClientResult>
    </getClientResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Services.asmx/getClient?username=string&password=string&clientNo=string HTTP/1.1
Host: services.tranzgate.com.ng

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ClientInfo xmlns="https://services.tranzgate.com.ng/">
  <ClientID>string</ClientID>
  <ClientName>string</ClientName>
  <UsesSession>boolean</UsesSession>
  <CustomerIDLabel>string</CustomerIDLabel>
  <UsesFeeService>boolean</UsesFeeService>
  <UsesPaymentPostingService>boolean</UsesPaymentPostingService>
  <UsesPaymentCancellationService>boolean</UsesPaymentCancellationService>
  <AdministrativeFeePaymentCode>string</AdministrativeFeePaymentCode>
  <TranzgateFeePaymentCode>string</TranzgateFeePaymentCode>
  <FinancialInstitutionFeePaymentCode>string</FinancialInstitutionFeePaymentCode>
  <UsesCustomerInfoService>boolean</UsesCustomerInfoService>
  <UsePreRegisteredCustomersOnly>boolean</UsePreRegisteredCustomersOnly>
  <ClientPaysInstitutionFee>boolean</ClientPaysInstitutionFee>
  <ClientPaysTranzgateFee>boolean</ClientPaysTranzgateFee>
  <ClientPaysAdministrativeFee>boolean</ClientPaysAdministrativeFee>
  <UsesFeeCreationService>boolean</UsesFeeCreationService>
  <UserCanChangeSwitch>boolean</UserCanChangeSwitch>
</ClientInfo>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Services.asmx/getClient HTTP/1.1
Host: services.tranzgate.com.ng
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&clientNo=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ClientInfo xmlns="https://services.tranzgate.com.ng/">
  <ClientID>string</ClientID>
  <ClientName>string</ClientName>
  <UsesSession>boolean</UsesSession>
  <CustomerIDLabel>string</CustomerIDLabel>
  <UsesFeeService>boolean</UsesFeeService>
  <UsesPaymentPostingService>boolean</UsesPaymentPostingService>
  <UsesPaymentCancellationService>boolean</UsesPaymentCancellationService>
  <AdministrativeFeePaymentCode>string</AdministrativeFeePaymentCode>
  <TranzgateFeePaymentCode>string</TranzgateFeePaymentCode>
  <FinancialInstitutionFeePaymentCode>string</FinancialInstitutionFeePaymentCode>
  <UsesCustomerInfoService>boolean</UsesCustomerInfoService>
  <UsePreRegisteredCustomersOnly>boolean</UsePreRegisteredCustomersOnly>
  <ClientPaysInstitutionFee>boolean</ClientPaysInstitutionFee>
  <ClientPaysTranzgateFee>boolean</ClientPaysTranzgateFee>
  <ClientPaysAdministrativeFee>boolean</ClientPaysAdministrativeFee>
  <UsesFeeCreationService>boolean</UsesFeeCreationService>
  <UserCanChangeSwitch>boolean</UserCanChangeSwitch>
</ClientInfo>

Parameter	Value
username:
password:
clientNo: