1. Home
  2. Application 24/7
  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).

Example SOAP request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="ns1">
   <soapenv:Header/>
   <soapenv:Body>
      <ns1:getMoneyStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
   </soapenv:Body>
</soapenv:Envelope>

Example SOAP response:

<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:ns1="ns1">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <ns1:getMoneyStatusResponse>
         <return xsi:type="ns1:vuiGetMoneyStatusResponse">
            <requestStatus>SUCCESS</requestStatus>
            <requestStatusDescription>Request succeeded.</requestStatusDescription>
                <item>
                    <freeBalance>
                        <amount>1000</amount>
                        <currency>PLN</currency>
                        <colour>0</colour>
                    </freeBalance>
                    <vaultBalance>
                        <amount>10000</amount>
                        <currency>PLN</currency>
                        <colour>0</colour>
                    </vaultBalance>
                    <lockedBalance>
                        <amount>0</amount>
                        <currency>PLN</currency>
                        <colour>0</colour>
                    </lockedBalance>
                    <total>
                        <amount>1000</amount>
                        <currency>ZER</currency>
                        <colour>0</colour>
                    </total>
                </item>
                <item>
                    <freeBalance>
                        <amount>40000</amount>
                        <currency>EUR</currency>
                        <colour>0</colour>
                    </freeBalance>
                    <vaultBalance>
                        <amount>0</amount>
                        <currency>EUR</currency>
                        <colour>0</colour>
                    </vaultBalance>
                    <lockedBalance>
                        <amount>0</amount>
                        <currency>EUR</currency>
                        <colour>0</colour>
                    </lockedBalance>
                    <total>
                        <amount>40000</amount>
                        <currency>EUR</currency>
                        <colour>0</colour>
                    </total>
                </item>
         </return>
      </ns1:getMoneyStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request parameters:

Message does not require parameters

Response parameters:

name type description
item vuiMoneyStatus list of money balance for each currency
lockedBalance billonAmount balance of locked money
freeBalance billonAmount balance of available money
vaultBalance billonAmount balance of money in vault
total billonAmount total money balance
requestStatus string result of request
requestStatusDescription string status description
Was this article helpful to you? Yes No

How can we help?