1. Home
  2. Corporate Node
  3. SOAP requests
  4. getMoneyStatus

getMoneyStatus

Operation getMoneyStatus returns information about user funds (available, in vault, locked).

This operation is used to check status of money on user account: accessible money (freeBalance), money in vault (vaultBalance),
and money currently in use: ie. transferring (lockedBalance). The first values corresponds to the user`s default currency and there then follows a list of all available currencies.

Example SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:getMoneyStatus>
  </ns:getMoneyStatus>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:getMoneyStatusResponse>
   <return>
    <requestStatus>SUCCESS</requestStatus>
    <requestStatusDescription>Request succeeded.</requestStatusDescription>
    <freeBalance>
     <amount>955</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </freeBalance>
    <vaultBalance>
     <amount>0</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </vaultBalance>
    <lockedBalance>
     <amount>5005</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </lockedBalance>
    <unpaidCommission>
     <amount>0</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </unpaidCommission>
    <commissionInProgress>
     <amount>0</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </commissionInProgress>
    <total>
     <amount>5960</amount>
     <currency>PLN</currency>
     <colour>0</colour>
    </total>
    <item>
     <freeBalance>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </freeBalance>
     <vaultBalance>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </vaultBalance>
     <lockedBalance>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </lockedBalance>
     <unpaidCommission>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </unpaidCommission>
     <commissionInProgress>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </commissionInProgress>
     <total>
      <amount>0</amount>
      <currency>GBP</currency>
      <colour>0</colour>
     </total>
    </item>
    <item>
     <freeBalance>
      <amount>955</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </freeBalance>
     <vaultBalance>
      <amount>0</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </vaultBalance>
     <lockedBalance>
      <amount>5005</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </lockedBalance>
     <unpaidCommission>
      <amount>0</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </unpaidCommission>
     <commissionInProgress>
      <amount>0</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </commissionInProgress>
     <total>
      <amount>5960</amount>
      <currency>PLN</currency>
      <colour>0</colour>
     </total>
    </item>
   </return>
  </ns:getMoneyStatusResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request parameters:

Message does not require parameters.

Response parameters:

NameTypeDescription
requestStatusstringThe status of the execution of the request
requestStatusDescriptionstringA description of the status
freeBalancebillonAmountFree cash balance
vaultBalancebillonAmountThe vault balance
lockedBalancebillonAmountThe reserved cash balance
unpaidCommissionbillonAmountA balance of yet unpaid commissions
commissionInProgressbillonAmountA balance of the comissions that are being charged
totalbillonAmountThe total cash balance
itemvuiMoneyStatusThe list of the cash balances for each currency
Was this article helpful to you? Yes No

How can we help?