Status

Return the status of the specified card.

Request Path Parameters

ParametertypeLimitsrequiredDescription
terminalIDString10 characters✓The Paymentology issued terminal id of the terminal requesting the transaction
referenceString1-255 characters✓The user defined reference to the card; for example a member id or wallet number
cardIdentifierString1-20 characters✓The card number, sequence number or tracking number of the specified card. Field is required but can accept empty string
transactionIDString1-255 characters✓A unique identifier generated by the client, which must not be duplicated over time.
transactionDateDate✓Client generated / local Transaction Date to assist in identifying transactions on the client side
checksumString✓HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key
<methodCall>
    <methodName>Status</methodName>
    <params>
        <param>
            <value>
                <string>0074223123</string>
            </value>
        </param>
        <param>
            <value>
                <string>03381441349</string>
            </value>
        </param>
        <param>
            <value>
                <string>633789401231489</string>
            </value>
        </param>
        <param>
            <value>
                <string>9047</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20170314T09:05:59</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>B466A5A08AEBF767D685FA477F1F472A3A948D61</string>
            </value>
        </param>
    </params>
</methodCall>

Response Parameters

FieldtypeDescription
validBooleanIs the card valid
pinBlockedBooleanIs the card blocked for exceeding maximum PIN tries
activatedBooleanIs the card activated
retiredBooleanIs the card retired
loadedBooleanIs the card loaded
redeemedBooleanIs the card redeemed
emptyBooleanIs the card empty
cancelledBooleanIs the card cancelled
stoppedBooleanIs the card stopped
lostBooleanIs the card lost
stolenBooleanIs the card stolen
expiredBooleanIs the card expired
resultCodeIntegerStatus code indicating transaction result
<methodResponse>
<params>
    <param>
        <value>
            <struct>
                <member>
                    <name>pinBlocked</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>stolen</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>valid</name>
                    <value>
                        <boolean>1</boolean>
                    </value>
                </member>
                <member>
                    <name>lost</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>expired</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>resultText</name>
                    <value>
                        <string>Approved</string>
                    </value>
                </member>
                <member>
                    <name>loaded</name>
                    <value>
                        <boolean>1</boolean>
                    </value>
                </member>
                <member>
                    <name>resultCode</name>
                    <value>
                        <int>1</int>
                    </value>
                </member>
                <member>
                    <name>cancelled</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>retired</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>stopped</name>
                    <value>
                        <boolean>0</boolean>
                    </value>
                </member>
                <member>
                    <name>activated</name>
                    <value>
                        <boolean>1</boolean>
                    </value>
                </member>
                <member>
                    <name>empty</name>
                    <value>
                        <boolean>1</boolean>
                    </value>
                </member>
                <member>
                    <name>redeemed</name>
                    <value>
                        <boolean>1</boolean>
                    </value>
                </member>
            </struct>
        </value>
    </param>
</params>
</methodResponse>