WS_MobileAPI Web Service

WS_MobileAPI

Click here for a complete list of operations.

APIRate

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 /mobilesrv/WS_MobileAPI.asmx HTTP/1.1
Host: hqiemobileuat.com.qa
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/APIRate"

<?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>
    <APIRate xmlns="http://tempuri.org/">
      <objAPIRaterequest>
        <signature>string</signature>
        <serviceName>string</serviceName>
        <dateStamp>string</dateStamp>
        <deviceUID>string</deviceUID>
        <companyCode>string</companyCode>
        <remCode>string</remCode>
        <correspondent>string</correspondent>
        <product>string</product>
        <beneSLNo>string</beneSLNo>
        <LCAmount>string</LCAmount>
        <FCAmount>string</FCAmount>
      </objAPIRaterequest>
    </APIRate>
  </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>
    <APIRateResponse xmlns="http://tempuri.org/">
      <APIRateResult>
        <ApiResponse>
          <StatusCode>int</StatusCode>
          <Message>string</Message>
          <Details>string</Details>
          <TimeStamp>string</TimeStamp>
        </ApiResponse>
        <latestDataFetchTime>string</latestDataFetchTime>
        <rateOutput>
          <rateOutput>
            <costRate>string</costRate>
            <tellerRate>string</tellerRate>
            <netAmount>string</netAmount>
            <charge>string</charge>
            <fcAmount>string</fcAmount>
            <Correspondent>string</Correspondent>
            <lcAmount>string</lcAmount>
            <serviceCharge>string</serviceCharge>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <margin>string</margin>
          </rateOutput>
          <rateOutput>
            <costRate>string</costRate>
            <tellerRate>string</tellerRate>
            <netAmount>string</netAmount>
            <charge>string</charge>
            <fcAmount>string</fcAmount>
            <Correspondent>string</Correspondent>
            <lcAmount>string</lcAmount>
            <serviceCharge>string</serviceCharge>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <margin>string</margin>
          </rateOutput>
        </rateOutput>
        <rateInput>
          <rateInput>
            <BM_SHNME>string</BM_SHNME>
            <pdt_servicecod>string</pdt_servicecod>
            <srv_datetime>string</srv_datetime>
            <entity>string</entity>
            <BbmWeb>string</BbmWeb>
            <OrgCountryCode>string</OrgCountryCode>
            <PayCurName>string</PayCurName>
            <SettlementCurCode>string</SettlementCurCode>
            <payerID>string</payerID>
            <hfDelType>string</hfDelType>
            <DestCountry>string</DestCountry>
            <BankAssCodeValue>string</BankAssCodeValue>
            <BrassignCodeValue>string</BrassignCodeValue>
            <margin>string</margin>
            <Operator>string</Operator>
            <TransferMode>string</TransferMode>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <rateConfiguration>string</rateConfiguration>
            <offlineRate>string</offlineRate>
          </rateInput>
          <rateInput>
            <BM_SHNME>string</BM_SHNME>
            <pdt_servicecod>string</pdt_servicecod>
            <srv_datetime>string</srv_datetime>
            <entity>string</entity>
            <BbmWeb>string</BbmWeb>
            <OrgCountryCode>string</OrgCountryCode>
            <PayCurName>string</PayCurName>
            <SettlementCurCode>string</SettlementCurCode>
            <payerID>string</payerID>
            <hfDelType>string</hfDelType>
            <DestCountry>string</DestCountry>
            <BankAssCodeValue>string</BankAssCodeValue>
            <BrassignCodeValue>string</BrassignCodeValue>
            <margin>string</margin>
            <Operator>string</Operator>
            <TransferMode>string</TransferMode>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <rateConfiguration>string</rateConfiguration>
            <offlineRate>string</offlineRate>
          </rateInput>
        </rateInput>
        <SlabCharge>
          <BeneSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneSlabCharge>
          <BeneSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneSlabCharge>
        </SlabCharge>
        <Purpose>
          <POTOT>
            <CDE>string</CDE>
            <NME>string</NME>
            <Status>string</Status>
          </POTOT>
          <POTOT>
            <CDE>string</CDE>
            <NME>string</NME>
            <Status>string</Status>
          </POTOT>
        </Purpose>
        <BeneBackendSlabCharge>
          <BeneBackendSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneBackendSlabCharge>
          <BeneBackendSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneBackendSlabCharge>
        </BeneBackendSlabCharge>
      </APIRateResult>
    </APIRateResponse>
  </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 /mobilesrv/WS_MobileAPI.asmx HTTP/1.1
Host: hqiemobileuat.com.qa
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>
    <APIRate xmlns="http://tempuri.org/">
      <objAPIRaterequest>
        <signature>string</signature>
        <serviceName>string</serviceName>
        <dateStamp>string</dateStamp>
        <deviceUID>string</deviceUID>
        <companyCode>string</companyCode>
        <remCode>string</remCode>
        <correspondent>string</correspondent>
        <product>string</product>
        <beneSLNo>string</beneSLNo>
        <LCAmount>string</LCAmount>
        <FCAmount>string</FCAmount>
      </objAPIRaterequest>
    </APIRate>
  </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>
    <APIRateResponse xmlns="http://tempuri.org/">
      <APIRateResult>
        <ApiResponse>
          <StatusCode>int</StatusCode>
          <Message>string</Message>
          <Details>string</Details>
          <TimeStamp>string</TimeStamp>
        </ApiResponse>
        <latestDataFetchTime>string</latestDataFetchTime>
        <rateOutput>
          <rateOutput>
            <costRate>string</costRate>
            <tellerRate>string</tellerRate>
            <netAmount>string</netAmount>
            <charge>string</charge>
            <fcAmount>string</fcAmount>
            <Correspondent>string</Correspondent>
            <lcAmount>string</lcAmount>
            <serviceCharge>string</serviceCharge>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <margin>string</margin>
          </rateOutput>
          <rateOutput>
            <costRate>string</costRate>
            <tellerRate>string</tellerRate>
            <netAmount>string</netAmount>
            <charge>string</charge>
            <fcAmount>string</fcAmount>
            <Correspondent>string</Correspondent>
            <lcAmount>string</lcAmount>
            <serviceCharge>string</serviceCharge>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <margin>string</margin>
          </rateOutput>
        </rateOutput>
        <rateInput>
          <rateInput>
            <BM_SHNME>string</BM_SHNME>
            <pdt_servicecod>string</pdt_servicecod>
            <srv_datetime>string</srv_datetime>
            <entity>string</entity>
            <BbmWeb>string</BbmWeb>
            <OrgCountryCode>string</OrgCountryCode>
            <PayCurName>string</PayCurName>
            <SettlementCurCode>string</SettlementCurCode>
            <payerID>string</payerID>
            <hfDelType>string</hfDelType>
            <DestCountry>string</DestCountry>
            <BankAssCodeValue>string</BankAssCodeValue>
            <BrassignCodeValue>string</BrassignCodeValue>
            <margin>string</margin>
            <Operator>string</Operator>
            <TransferMode>string</TransferMode>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <rateConfiguration>string</rateConfiguration>
            <offlineRate>string</offlineRate>
          </rateInput>
          <rateInput>
            <BM_SHNME>string</BM_SHNME>
            <pdt_servicecod>string</pdt_servicecod>
            <srv_datetime>string</srv_datetime>
            <entity>string</entity>
            <BbmWeb>string</BbmWeb>
            <OrgCountryCode>string</OrgCountryCode>
            <PayCurName>string</PayCurName>
            <SettlementCurCode>string</SettlementCurCode>
            <payerID>string</payerID>
            <hfDelType>string</hfDelType>
            <DestCountry>string</DestCountry>
            <BankAssCodeValue>string</BankAssCodeValue>
            <BrassignCodeValue>string</BrassignCodeValue>
            <margin>string</margin>
            <Operator>string</Operator>
            <TransferMode>string</TransferMode>
            <ISPKRAPPLICABLE>string</ISPKRAPPLICABLE>
            <PKRLIMITLC>decimal</PKRLIMITLC>
            <HIGHERLIMITFC>decimal</HIGHERLIMITFC>
            <REBSTS>int</REBSTS>
            <REBMSG>string</REBMSG>
            <rateConfiguration>string</rateConfiguration>
            <offlineRate>string</offlineRate>
          </rateInput>
        </rateInput>
        <SlabCharge>
          <BeneSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneSlabCharge>
          <BeneSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneSlabCharge>
        </SlabCharge>
        <Purpose>
          <POTOT>
            <CDE>string</CDE>
            <NME>string</NME>
            <Status>string</Status>
          </POTOT>
          <POTOT>
            <CDE>string</CDE>
            <NME>string</NME>
            <Status>string</Status>
          </POTOT>
        </Purpose>
        <BeneBackendSlabCharge>
          <BeneBackendSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneBackendSlabCharge>
          <BeneBackendSlabCharge>
            <FromAmount>decimal</FromAmount>
            <ToAmount>decimal</ToAmount>
            <Charge>decimal</Charge>
          </BeneBackendSlabCharge>
        </BeneBackendSlabCharge>
      </APIRateResult>
    </APIRateResponse>
  </soap12:Body>
</soap12:Envelope>