Services Web Service

Services

Click here for a complete list of operations.

getCommissions

Test

The test form is only available for requests from the local machine.

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

<?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>
    <getCommissions xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <clientNo>string</clientNo>
      <subtotal>decimal</subtotal>
      <channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</channel>
      <customerinfo>
        <CustomerID>string</CustomerID>
        <CustomerName>string</CustomerName>
        <Mobile>string</Mobile>
        <Email>string</Email>
      </customerinfo>
    </getCommissions>
  </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>
    <getCommissionsResponse xmlns="https://services.tranzgate.com.ng/">
      <getCommissionsResult>
        <PaymentInfo>
          <PaymentBatchID>string</PaymentBatchID>
          <PaymentDetailID>long</PaymentDetailID>
          <ClientID>string</ClientID>
          <ClientName>string</ClientName>
          <CustomerID>string</CustomerID>
          <CustomerName>string</CustomerName>
          <PaymentCode>string</PaymentCode>
          <PaymentInfoString>string</PaymentInfoString>
          <Currency>Naira or Dollars or Pounds or Euros</Currency>
          <Amount>decimal</Amount>
          <Mandatory>boolean</Mandatory>
          <Adjustable>boolean</Adjustable>
          <PushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</PushStatus>
          <PushErrorDetails>string</PushErrorDetails>
          <PaymentDocumentNo>string</PaymentDocumentNo>
          <Session>string</Session>
          <BankID>string</BankID>
          <SettlementAccount>string</SettlementAccount>
          <Channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</Channel>
          <Cancelled>boolean</Cancelled>
          <Commission>boolean</Commission>
          <FinancialInstitutionCommission>boolean</FinancialInstitutionCommission>
          <ChannelStatus>string</ChannelStatus>
          <ChannelStatusDescription>string</ChannelStatusDescription>
          <PaymentDate>dateTime</PaymentDate>
          <PaymentDateTime>dateTime</PaymentDateTime>
          <TranzgateCommission>boolean</TranzgateCommission>
          <AdministrativeCommission>boolean</AdministrativeCommission>
          <PaidByClient>boolean</PaidByClient>
          <Paid>boolean</Paid>
          <RemitaRRR>string</RemitaRRR>
        </PaymentInfo>
        <PaymentInfo>
          <PaymentBatchID>string</PaymentBatchID>
          <PaymentDetailID>long</PaymentDetailID>
          <ClientID>string</ClientID>
          <ClientName>string</ClientName>
          <CustomerID>string</CustomerID>
          <CustomerName>string</CustomerName>
          <PaymentCode>string</PaymentCode>
          <PaymentInfoString>string</PaymentInfoString>
          <Currency>Naira or Dollars or Pounds or Euros</Currency>
          <Amount>decimal</Amount>
          <Mandatory>boolean</Mandatory>
          <Adjustable>boolean</Adjustable>
          <PushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</PushStatus>
          <PushErrorDetails>string</PushErrorDetails>
          <PaymentDocumentNo>string</PaymentDocumentNo>
          <Session>string</Session>
          <BankID>string</BankID>
          <SettlementAccount>string</SettlementAccount>
          <Channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</Channel>
          <Cancelled>boolean</Cancelled>
          <Commission>boolean</Commission>
          <FinancialInstitutionCommission>boolean</FinancialInstitutionCommission>
          <ChannelStatus>string</ChannelStatus>
          <ChannelStatusDescription>string</ChannelStatusDescription>
          <PaymentDate>dateTime</PaymentDate>
          <PaymentDateTime>dateTime</PaymentDateTime>
          <TranzgateCommission>boolean</TranzgateCommission>
          <AdministrativeCommission>boolean</AdministrativeCommission>
          <PaidByClient>boolean</PaidByClient>
          <Paid>boolean</Paid>
          <RemitaRRR>string</RemitaRRR>
        </PaymentInfo>
      </getCommissionsResult>
    </getCommissionsResponse>
  </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>
    <getCommissions xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <clientNo>string</clientNo>
      <subtotal>decimal</subtotal>
      <channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</channel>
      <customerinfo>
        <CustomerID>string</CustomerID>
        <CustomerName>string</CustomerName>
        <Mobile>string</Mobile>
        <Email>string</Email>
      </customerinfo>
    </getCommissions>
  </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>
    <getCommissionsResponse xmlns="https://services.tranzgate.com.ng/">
      <getCommissionsResult>
        <PaymentInfo>
          <PaymentBatchID>string</PaymentBatchID>
          <PaymentDetailID>long</PaymentDetailID>
          <ClientID>string</ClientID>
          <ClientName>string</ClientName>
          <CustomerID>string</CustomerID>
          <CustomerName>string</CustomerName>
          <PaymentCode>string</PaymentCode>
          <PaymentInfoString>string</PaymentInfoString>
          <Currency>Naira or Dollars or Pounds or Euros</Currency>
          <Amount>decimal</Amount>
          <Mandatory>boolean</Mandatory>
          <Adjustable>boolean</Adjustable>
          <PushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</PushStatus>
          <PushErrorDetails>string</PushErrorDetails>
          <PaymentDocumentNo>string</PaymentDocumentNo>
          <Session>string</Session>
          <BankID>string</BankID>
          <SettlementAccount>string</SettlementAccount>
          <Channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</Channel>
          <Cancelled>boolean</Cancelled>
          <Commission>boolean</Commission>
          <FinancialInstitutionCommission>boolean</FinancialInstitutionCommission>
          <ChannelStatus>string</ChannelStatus>
          <ChannelStatusDescription>string</ChannelStatusDescription>
          <PaymentDate>dateTime</PaymentDate>
          <PaymentDateTime>dateTime</PaymentDateTime>
          <TranzgateCommission>boolean</TranzgateCommission>
          <AdministrativeCommission>boolean</AdministrativeCommission>
          <PaidByClient>boolean</PaidByClient>
          <Paid>boolean</Paid>
          <RemitaRRR>string</RemitaRRR>
        </PaymentInfo>
        <PaymentInfo>
          <PaymentBatchID>string</PaymentBatchID>
          <PaymentDetailID>long</PaymentDetailID>
          <ClientID>string</ClientID>
          <ClientName>string</ClientName>
          <CustomerID>string</CustomerID>
          <CustomerName>string</CustomerName>
          <PaymentCode>string</PaymentCode>
          <PaymentInfoString>string</PaymentInfoString>
          <Currency>Naira or Dollars or Pounds or Euros</Currency>
          <Amount>decimal</Amount>
          <Mandatory>boolean</Mandatory>
          <Adjustable>boolean</Adjustable>
          <PushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</PushStatus>
          <PushErrorDetails>string</PushErrorDetails>
          <PaymentDocumentNo>string</PaymentDocumentNo>
          <Session>string</Session>
          <BankID>string</BankID>
          <SettlementAccount>string</SettlementAccount>
          <Channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</Channel>
          <Cancelled>boolean</Cancelled>
          <Commission>boolean</Commission>
          <FinancialInstitutionCommission>boolean</FinancialInstitutionCommission>
          <ChannelStatus>string</ChannelStatus>
          <ChannelStatusDescription>string</ChannelStatusDescription>
          <PaymentDate>dateTime</PaymentDate>
          <PaymentDateTime>dateTime</PaymentDateTime>
          <TranzgateCommission>boolean</TranzgateCommission>
          <AdministrativeCommission>boolean</AdministrativeCommission>
          <PaidByClient>boolean</PaidByClient>
          <Paid>boolean</Paid>
          <RemitaRRR>string</RemitaRRR>
        </PaymentInfo>
      </getCommissionsResult>
    </getCommissionsResponse>
  </soap12:Body>
</soap12:Envelope>