CardDetail

Get the details of a card that is identified by the given tracking number.

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string,  1-255 characters,  required

Customer reference linked with this card

trackingNumber

string,  1-20 characters,  required

Tracking number that identifies the card to be returned

transactionID

string,  1-255 characters,  required

A unique identifier generated by the client, which must not be duplicated over time.

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

<methodCall>
    <methodName type="xs:string">CardDetail</methodName>
    <params>
        <param>
            <value>
                <string>1234567890</string>
            </value>
        </param>
        <param>
            <value>
                <string>TEST_CUSTOMER</string>
            </value>
        </param>
        <param>
            <value>
                <string>123456789874561</string>
            </value>
        </param>
        <param>
            <value>
                <string>d12d3df4-4e11-45a5-a11c-101c7175dfdb</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20160525T00:00:00</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>1F008A133D69E482FEBEBB9A1120545DCFB4C4DD</string>
            </value>
        </param>
    </params>
</methodCall>

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

campaignUUID

string

The campaign UUID the card belongs to

cardLabel

string

The card label

cardNumber

string

The full 16-digit card number

cvv2

string

The CVV2 for the card

expiryDate

date

The expiry date of the card

balance

array

Balances of pockets linked to the card

currency

string

The currency of this card

stopped

string

A text string explaining the reason the card is stopped, else an empty string for a card that is not stopped

clientTransactionID

string

Echo

serverTransactionID

string

Transaction ID number generated by Paymentology

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>currency</name>
                        <value>
                            <string>840</string>
                        </value>
                    </member>
                    <member>
                        <name>customerReference</name>
                        <value>
                            <string>TEST_CUSTOMER</string>
                        </value>
                    </member>
                    <member>
                        <name>balanceAmount</name>
                        <value>
                            <int>0</int>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>12F34B5B-678D-9108-7DAE65F4321123CD</string>
                        </value>
                    </member>
                    <member>
                        <name>expiryDate</name>
                        <value>
                            <dateTime.iso8601>20161125T00:00:00</dateTime.iso8601>
                        </value>
                    </member>
                    <member>
                        <name>cardLabel</name>
                        <value>
                            <string>TestCard</string>
                        </value>
                    </member>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>d12d3df4-4e11-45a5-a11c-101c7175dfdb</string>
                        </value>
                    </member>
                    <member>
                        <name>cvv2</name>
                        <value>
                            <string>000</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>1234567890</string>
                        </value>
                    </member>
                    <member>
                        <name>cardNumber</name>
                        <value>
                            <string>1234567898765432</string>
                        </value>
                    </member>
                    <member>
                        <name>stopped</name>
                        <value>
                            <string/>
                        </value>
                    </member>
                    <member>
                        <name>campaignUUID</name>
                        <value>
                            <string>1234F2C8-155D-0028-9DEA0D24AD111DA0</string>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>123456789874561</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.