Financial

Get Financial Balance

getFinancialBalance

Used to retrieve the agent's current financial account balance.

Permissions Required

Permissions are required for the agent to access this method.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
currencyCode	String	3	Yes	Account Currency. E.g.: "USD"

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
balance	String	The financial balance for the provided currency
currency	String
currentDateTime	DateTime	Response date time

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getFinancialBalance>
         <currencyCode>USD</currencyCode>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getFinancialBalance>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:getFinancialBalanceResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:balance>Cr 4687.56</ns2:balance>
            <ns2:currency>USD</ns2:currency>
            <ns2:currentDateTime>01/10/2025 12:24:00 PM</ns2:currentDateTime>
         </return>
      </ns3:getFinancialBalanceResponse>
   </S:Body>
</S:Envelope>

---

Get Settlement Report

getSettlementReport

This method is used to retrieve the agent settlement report.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
fromDate	Date		Yes	Format: dd/MM/yyyy
toDate	Date		Yes	Format: dd/MM/yyyy

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
AgentSettlementTransationList	List of Objects	Contains settlement transaction details. See below AgentSettlementTransationList

AgentSettlementTransationList

AgentSettlementTransationList Object fields

Field	Type	Description
remittanceTrackingCode	String
apiAgentReferenceNumber	String	Will be returned if available
date	DateTime
type	String	Possible transaction types: Send, Modification, Send Reversal, Modify Reversal, Receive, Refund, Receive Reversal
currencyCode	String	ISO Alpha3
amount	Decimal
charges	Decimal
fxRate	Decimal
settlementAmount	Decimal
settlementCharges	Decimal
agentChargesShare	Decimal
agentFxShare	Decimal

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getSettlementReport>
         <fromDate>13/07/2020</fromDate>
         <toDate>14/07/2020</toDate>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getSettlementReport>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:getSettlementReportResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:AgentSettlementTransationList>
               <ns2:remittanceTrackingCode>49670088378</ns2:remittanceTrackingCode>
               <ns2:date>14/07/2020 10:57:58 AM</ns2:date>
               <ns2:type>Send</ns2:type>
               <ns2:currencyCode>JOD</ns2:currencyCode>
               <ns2:amount>100.0</ns2:amount>
               <ns2:charges>2.84</ns2:charges>
               <ns2:fxRate>0.7089</ns2:fxRate>
               <ns2:settlementAmount>141.06</ns2:settlementAmount>
               <ns2:settlementCharges>4.0</ns2:settlementCharges>
               <ns2:agentChargesShare>2.0</ns2:agentChargesShare>
               <ns2:agentFxShare>0.0</ns2:agentFxShare>
            </ns2:AgentSettlementTransationList>
            <ns2:AgentSettlementTransationList>
               <ns2:remittanceTrackingCode>49670088378</ns2:remittanceTrackingCode>
               <ns2:date>14/07/2020 11:27:29 AM</ns2:date>
               <ns2:type>Modify Reversal</ns2:type>
               <ns2:currencyCode>JOD</ns2:currencyCode>
               <ns2:amount>100.0</ns2:amount>
               <ns2:charges>2.84</ns2:charges>
               <ns2:fxRate>0.7089</ns2:fxRate>
               <ns2:settlementAmount>141.06</ns2:settlementAmount>
               <ns2:settlementCharges>4.0</ns2:settlementCharges>
               <ns2:agentChargesShare>2.0</ns2:agentChargesShare>
               <ns2:agentFxShare>0.0</ns2:agentFxShare>
            </ns2:AgentSettlementTransationList>
         </return>
      </ns3:getSettlementReportResponse>
   </S:Body>
</S:Envelope>