Services Web Service

Services

Click here for a complete list of operations.

getClients

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/getClients"

<?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>
    <getClients xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
    </getClients>
  </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>
    <getClientsResponse xmlns="https://services.tranzgate.com.ng/">
      <getClientsResult>
        <ClientInfo>
          <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>
        <ClientInfo>
          <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>
      </getClientsResult>
    </getClientsResponse>
  </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>
    <getClients xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
    </getClients>
  </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>
    <getClientsResponse xmlns="https://services.tranzgate.com.ng/">
      <getClientsResult>
        <ClientInfo>
          <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>
        <ClientInfo>
          <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>
      </getClientsResult>
    </getClientsResponse>
  </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/getClients?username=string&password=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"?>
<ArrayOfClientInfo xmlns="https://services.tranzgate.com.ng/">
  <ClientInfo>
    <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>
  <ClientInfo>
    <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>
</ArrayOfClientInfo>

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/getClients HTTP/1.1
Host: services.tranzgate.com.ng
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfClientInfo xmlns="https://services.tranzgate.com.ng/">
  <ClientInfo>
    <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>
  <ClientInfo>
    <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>
</ArrayOfClientInfo>

Parameter	Value
username:
password: