Web Service - Methods - GetCreditsLeft

GetCreditsLeft

This method is used to query the number of Message Credits remaining on a client’s pre-pay account.

You can choose to receive the return code data from this method as either a CSV string or XML through your setting of the returnCSVString parameter.

If a CSV string is requested, the first line will contain the Transaction code contained within the '#' characters.

» returnCSVString» Boolean
» externalLogin» String
» password» String

On successful completion of this method, the number of Message Credits remaining on the client’s account is returned, as a real number.

If the account is found, and the account is a Credit Account (where messages are not pre-purchased), then the method will return:

“-1”

Return Data

XML:

<GetCreditLeftResponse> 
    <Transaction> 
        <IP>127.0.0.1</IP> 
        <Code>1</Code> 
        <Description>Transaction  OK</Description> 
    </Transaction> 
    <CreditLeft>175.60</CreditLeft> 
</GetCreditLeftResponse>
        

CSV:

#1# 175.60

Footer Bottom