Balance
Retrieve the balance of a card.
Request
Path parameters
string, 10 characters, required
The Paymentology issued terminal ID of the terminal requesting the transaction
string, 1-20 characters, required
Profile number linked with this card
string, 1-20 characters, required
The card number, sequence number or tracking number of the specified card
string, 1-255 characters, required
Transaction ID number generated by the calling client
date, required
Transaction date generated by the calling client
string, required
HMAC-SHA1 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>1234567890</string>
</value>
</param>
<param>
<value>
<string>P12345</string>
</value>
</param>
<param>
<value>
<string>C67890</string>
</value>
</param>
<param>
<value>
<string>T987654321</string>
</value>
</param>
<param>
<value>
<dateTime.iso8601>2023-11-08T12:34:44</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>f9a7abc3d33e91jk1c9d1234a58e49f22a1c</string>
</value>
</param>
</params>
</methodCall>
Response
STATUS200 OK
Schema
string
Echo of incoming value
string
Echo of incoming value
string
Number of the card found using the cardIdentifier
integer
Balance amount in cents
date
The expiry date of the card
boolean
Is the card expired
boolean
Is the card stopped
boolean
Is the card stolen
boolean
Is the card lost
string
Echo of incoming value
date
Transaction ID generated by Paymentology
integer
Status code indicating transaction result
string
Text indicating transaction result
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>terminalID</name>
<value>
<string>1234567890</string>
</value>
</member>
<member>
<name>profileNumber</name>
<value>
<string>P12345</string>
</value>
</member>
<member>
<name>cardNumber</name>
<value>
<string>1234 4444 9012 4444</string>
</value>
</member>
<member>
<name>balanceAmount</name>
<value>
<int>107444</int>
</value>
</member>
<member>
<name>expiryDate</name>
<value>
<dateTime.iso8601>2023-12-31T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>expired</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>stopped</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>stolen</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>lost</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>clientTransactionID</name>
<value>
<string>T987654321</string>
</value>
</member>
<member>
<name>serverTransactionID</name>
<value>
<dateTime.iso8601>2023-11-08T12:35:00</dateTime.iso8601>
</value>
</member>
<member>
<name>resultCode</name>
<value>
<int>200</int>
</value>
</member>
<member>
<name>resultText</name>
<value>
<string>Balance retrieved successfully</string>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
Was this page helpful?