Balance

POST https://example.com/balance

Check the balance of a card linked to a wallet.

This operation queries a card balance using multiple authentication and context parameters.

REQUEST

PATH PARAMETERS

Parameter	Type & Constraints	Description
terminalID	string, 10 characters, required	Our partner 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 Lookup](/reference/klv-lookup)
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>0021576138...</string></value>
          </param>
          <param>
            <value><string>415099</string></value>
          </param>
          <param>
            <value><dateTime.iso8601>20200824T14:17:06</dateTime.iso8601></value>
          </param>
          <param>
            <value><string>46719079...</string></value>
          </param>
        </params>
      </methodCall>
    

RESPONSE

STATUS: 200 OK

SCHEMA:

Field	Type	Description
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>