Services Web Service

Services

Click here for a complete list of operations.

searchPaymentsFull

Test

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

Parameter	Value
username:
password:
paymentbatchid:
paymentdetailid:
clientid:
paymentcode:
bank:
channel:
customerid:
startDate:
endDate:
paid:
cancelled:
pushStatus:
page:
numberperpage:
rrr:
paymentdocumentno:
totalonly:
includeCharges:

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

<?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>
    <searchPaymentsFull xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <paymentbatchid>string</paymentbatchid>
      <paymentdetailid>long</paymentdetailid>
      <clientid>string</clientid>
      <paymentcode>string</paymentcode>
      <bank>string</bank>
      <channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</channel>
      <customerid>string</customerid>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <paid>NotSet or Yes or No</paid>
      <cancelled>NotSet or Yes or No</cancelled>
      <pushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</pushStatus>
      <page>int</page>
      <numberperpage>long</numberperpage>
      <rrr>string</rrr>
      <paymentdocumentno>string</paymentdocumentno>
      <totalonly>boolean</totalonly>
      <includeCharges>boolean</includeCharges>
    </searchPaymentsFull>
  </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>
    <searchPaymentsFullResponse xmlns="https://services.tranzgate.com.ng/">
      <searchPaymentsFullResult>
        <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>
      </searchPaymentsFullResult>
    </searchPaymentsFullResponse>
  </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>
    <searchPaymentsFull xmlns="https://services.tranzgate.com.ng/">
      <username>string</username>
      <password>string</password>
      <paymentbatchid>string</paymentbatchid>
      <paymentdetailid>long</paymentdetailid>
      <clientid>string</clientid>
      <paymentcode>string</paymentcode>
      <bank>string</bank>
      <channel>NotSet or Bank or Interswitch2023 or UnifiedPayments or RemitaBank or RemitaOnline or UnifiedPaymentsPOS or ALATPay or Zitra or ZitraTranzgate or Nomba</channel>
      <customerid>string</customerid>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <paid>NotSet or Yes or No</paid>
      <cancelled>NotSet or Yes or No</cancelled>
      <pushStatus>NotSet or NotPushed or Pushed or Rejected or Error or ServiceUnreachable</pushStatus>
      <page>int</page>
      <numberperpage>long</numberperpage>
      <rrr>string</rrr>
      <paymentdocumentno>string</paymentdocumentno>
      <totalonly>boolean</totalonly>
      <includeCharges>boolean</includeCharges>
    </searchPaymentsFull>
  </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>
    <searchPaymentsFullResponse xmlns="https://services.tranzgate.com.ng/">
      <searchPaymentsFullResult>
        <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>
      </searchPaymentsFullResult>
    </searchPaymentsFullResponse>
  </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/searchPaymentsFull?username=string&password=string&paymentbatchid=string&paymentdetailid=string&clientid=string&paymentcode=string&bank=string&channel=string&customerid=string&startDate=string&endDate=string&paid=string&cancelled=string&pushStatus=string&page=string&numberperpage=string&rrr=string&paymentdocumentno=string&totalonly=string&includeCharges=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"?>
<ArrayOfPaymentInfo xmlns="https://services.tranzgate.com.ng/">
  <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>
</ArrayOfPaymentInfo>

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

username=string&password=string&paymentbatchid=string&paymentdetailid=string&clientid=string&paymentcode=string&bank=string&channel=string&customerid=string&startDate=string&endDate=string&paid=string&cancelled=string&pushStatus=string&page=string&numberperpage=string&rrr=string&paymentdocumentno=string&totalonly=string&includeCharges=string

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

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