Retrieve the statement of a card.
NOTE: Do not use the Statement method when the Balance method will be sufficient, as the Statement method may take considerably longer to return a response.
Request Path Parameters
| Parameter | type | Limits | required | Description |
|---|---|---|---|---|
| terminalID | String | 10 characters | ✓ | The Paymentology issued terminal ID of the terminal requesting the transaction. |
| profileNumber | String | 1-20 characters | ✓ | The profile to which the card belongs. |
| cardIdentifier | String | 1-20 characters | ✓ | The card number, tracking number or sequence number of the card to retrieve the statement for. |
| transactionID | String | 1-255 characters | ✓ | Transaction ID number generated by the calling client. |
| transactionDate | Date | ✓ | Transaction date generated by the calling client. | |
| checksum | String | ✓ | 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>Statement</methodName>
<params>
<param>
<value>
<string>1238123452</string>
</value>
</param>
<param>
<value>
<string>2365765438</string>
</value>
</param>
<param>
<value>
<string>2365897</string>
</value>
</param>
<param>
<value>
<string>123se12345fsc</string>
</value>
</param>
<param>
<value>
<dateTime.iso8601>20230228T13:26:57</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>73FBA22C33460B01D759D57AAE47571320BAD562</string>
</value>
</param>
</params>
</methodCall>Response Parameters
| Parameter | type | Description |
|---|---|---|
| terminalID | String | Echo of incoming value. |
| profileNumber | String | Echo of incoming value. |
| cardNumber | String | Number of the card found using the cardIdenitifier. |
| balanceAmount | Integer | Balance amount in cents. |
| expiryDate | Date | The expiry date of the card. |
| statement | Array | The transaction history of the card.; ; The array includes:; ; transactionDate – Date of the transaction (date); ; transactionAmount – Amount of the transactionin cents (integer); ; transactionDescription – Name of the merchant where the transaction originated (string); ; transactionType – Type of the transaction:; ; 1. load; ; 2. deduction; ; 3. authorisation; ; (integer) |
| clientTransactionID | String | Echo of incoming value. |
| serverTransactionID | Date | Transaction ID generated by Paymentology. |
| resultCode | Integer | Status code indicating the transaction result. |
| resultText | String | Text indicating the transaction result. |
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>statement</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>transactionType</name>
<value>
<int>1</int>
</value>
</member>
<member>
<name>transactionDate</name>
<value>
<dateTime.iso8601>20221205T11:01:31</dateTime.iso8601>
</value>
</member>
<member>
<name>transactionAmount</name>
<value>
<int>130000</int>
</value>
</member>
<member>
<name>transactionDescription</name>
<value>
<string>load</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>transactionType</name>
<value>
<int>2</int>
</value>
</member>
<member>
<name>transactionDate</name>
<value>
<dateTime.iso8601>20221205T11:04:32</dateTime.iso8601>
</value>
</member>
<member>
<name>transactionAmount</name>
<value>
<int>10000</int>
</value>
</member>
<member>
<name>transactionDescription</name>
<value>
<string>deduct</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>transactionType</name>
<value>
<int>2</int>
</value>
</member>
<member>
<name>transactionDate</name>
<value>
<dateTime.iso8601>20221205T11:18:48</dateTime.iso8601>
</value>
</member>
<member>
<name>transactionAmount</name>
<value>
<int>119000</int>
</value>
</member>
<member>
<name>transactionDescription</name>
<value>
<string>bank transaction</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>clientTransactionID</name>
<value>
<string>123se12345fsc</string>
</value>
</member>
<member>
<name>resultCode</name>
<value>
<int>1</int>
</value>
</member>
<member>
<name>terminalID</name>
<value>
<string>1238123452</string>
</value>
</member>
<member>
<name>profileNumber</name>
<value>
<string>2365765438</string>
</value>
</member>
<member>
<name>cardNumber</name>
<value>
<string>5214789632654785</string>
</value>
</member>
<member>
<name>balanceAmount</name>
<value>
<int>160118</int>
</value>
</member>
<member>
<name>resultText</name>
<value>
<string>OK</string>
</value>
</member>
<member>
<name>expiryDate</name>
<value>
<dateTime.iso8601>20250930T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>serverTransactionID</name>
<value>
<string>2569874536-73FBA25C41460B56S459D57A1257571320BAD562</string>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>