Status

Return the status of the specified card.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

reference

string,  1-255 characters,  required

The user defined reference to the card; for example a member id or wallet number

cardIdentifier

string,  1-20 characters,  required

The card number, sequence number or tracking number of the specified card. Field is required but can accept empty string

transactionID

string,  1-255 characters,  required

Client generated Transaction ID to assist in identify transactions on the client side

transactionDate

date,  required

Client generated / local Transaction Date to assist in identifying transactions on the client side

checksum

string,  required

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

STATUS200 OK

Schema

valid

boolean

Is the card valid

pinBlocked

boolean

Is the card blocked for exceeding maximum PIN tries

activated

boolean

Is the card activated

retired

boolean

Is the card retired

loaded

boolean

Is the card loaded

redeemed

boolean

Is the card redeemed

empty

boolean

Is the card empty

cancelled

boolean

Is the card cancelled

stopped

boolean

Is the card stopped

lost

boolean

Is the card lost

stolen

boolean

Is the card stolen

expired

boolean

Is the card expired

resultCode

integer

Status 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>

 

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.