Balance

Checks the balance on a card.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

reference

string,  1-255 characters,  required

The reference of the wallet to retrieve the balance for

narrative

string,  1-255 characters,  required

A description of the terminal where the card was used

transactionData

string,  0-2048 characters,  required

Extra information about the transaction in a KLV format

transactionID

string,  1-255 characters,  required

Transaction ID number generated by the calling client. Note that the Transaction ID is not a unique value and may be duplicated over time

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  required

HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<?xml version="1.0"?>
<methodCall>
    <methodName>Balance</methodName>
    <params>
        <param>
            <value>
                <string>0029504320</string>
            </value>
        </param>
        <param>
            <value>
                <string>556789731480</string>
            </value>
        </param>
        <param>
            <value>
                <string>STARBUCKS              HANOI         VNM</string>
            </value>
        </param>
        <param>
            <value>
                <string>002157613861000015920041200000000000002604601103712127399089060041081234567804205123450490370405002300850025003MAG25110MasterCard252010253044562258010</string>
            </value>
        </param>
        <param>
            <value>
                <string>415099</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20200824T14:17:06</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>46719079E3BACE48D631E0A4361196BEB89C22B8</string>
            </value>
        </param>
    </params>
</methodCall>

 

Response

STATUS200 OK

Schema

balanceAmount

integer

Balance amount in cents

resultCode

integer

Status code indicating transaction result

actualBalance

integer

(Optional) Actual/settled balance in cents

addressVerificationResult

integer

(Optional) Address Verification Result

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>balanceAmount</name>
                        <value>
                            <int>626900</int>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

 

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.