StatementByDateRange

Returns the statement between two dates.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

profileNumber

string,  1-20 characters,  required

Profile number linked with this card

cardIdentifier

string,  1-20 characters,  required

Card number or Tracking number or Sequence number of the card

startDate

date,  required

The date when the statement starts

endDate

date,  required

The date when the statement ends

transactionID

string,  1-255 characters,  required

Transaction ID number generated by the calling client

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" encoding="UTF-8" standalone="yes"?>
<methodCall>
    <methodName>StatementByDateRange</methodName>
    <params>
        <param>
            <value>
                <string>1234567890</string>
            </value>
        </param>
        <param>
            <value>
                <string>5676576567</string>
            </value>
        </param>
        <param>
            <value>
                <string>4545464546454645</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20220915T06:24:15</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20230101T00:03:15</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>1234c3c83b0bc5656e787878</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20230101T00:03:15</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>1CF0D6E5565B5D042A30E60B56E7A0D98ASD1KJ3</string>
            </value>
        </param>
    </params>
</methodCall>

 

Response

STATUS200 OK

Schema

terminalID

string

Echo

profileNumber

string

Echo

cardNumber

string

Number of the card found using the cardIdentifier

balanceAmount

integer

Balance amount in cents

expiryDate

date

The expiry date of the card

Statement

array

The transaction history of the card:

transactionDate

Description: Date of the transaction

Type: date

transactionAmount

Description: amount of the transaction in cents

Type:    integer

transactionDescription

Description: Name of the merchant where transaction originated

Type: string

transactionType

Description: Type of the transaction i.e. load, deduction, authorisation

Type: integer

clientTransactionID

string

Echo

serverTransactionID

string

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></data>
                            </array>
                        </value>
                    </member>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>SMH1321234567890</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>4545454545</string>
                        </value>
                    </member>
                    <member>
                        <name>profileNumber</name>
                        <value>
                            <string>5656565656</string>
                        </value>
                    </member>
                    <member>
                        <name>cardNumber</name>
                        <value>
                            <string>5338925656565656</string>
                        </value>
                    </member>
                    <member>
                        <name>balanceAmount</name>
                        <value>
                            <int>2886000</int>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                    <member>
                        <name>expiryDate</name>
                        <value>
                            <dateTime.iso8601>20261130T00:00:00</dateTime.iso8601>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>8676767678-A5656567F20483DF38BB295BA490FBF777777F5B</string>
                        </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.