GetLinkedCards

Get an array of card details of all cards (active, stopped and retired) linked to the reference.

IMPORTANT:

This API method contains PCI sensitive information.

  • Session-Id=Encrypted AES Key e-g (AB521456236KHU52) is required if encryption is needed and the campaign is configured for encryption of sensitive data.
  • This is optional if encryption is not needed and the campaign is not configured for encryption of sensitive data.

You can read more on how our Secure API’s work here.

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

transactionID

string,  1-255 characters,  required

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

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>GetLinkedCards</methodname>
    <params>
        <param>
            <value>
                <string>0014682067</string>
            </value>
        </param>
        <param>
            <value>
                <string>TTKTEST</string>
            </value>
        </param>
        <param>
            <value>
                <string>123456</string>
            </value>
        </param>
        <param>
            <value>
                <datetime.iso8601>20200327T00:00:00</datetime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>B6942BA5F98449F067A3C7EC17E7B20545EF2B44</string>
            </value>
        </param>
    </params>
</methodcall>

Response

STATUS200 OK

Schema

cards

array

Array of structs containing card data.

Will contain encrypted fields (CVV2, card number, and expiry date) and an IV key (using which fields are encrypted) for each entry of card in the array.

resultCode

integer

Status code indicating transaction result.

resultText

string

Text indicating transaction result.

<methodresponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>cvv2</name>
                        <value>
                            <string>H524IK</string>
                        </value>
                    </member>
                    <member>
                        <name>cardNumber</name>
                        <value>
                            <string>5300000000003493</string>
                        </value>
                    </member>
                    <member>
                        <name>validDate</name>
                        <value>
                            <string>10/22</string>
                        </value>
                    </member>
                    <member>
                        <name>expiryDate</name>
                        <value>
                            <dateTime.iso8601>20290901T00:00:00</dateTime.iso8601>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>189469100000008</string>
                        </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>expired</name>
                      <value>
                        <boolean>0</boolean>
                      </value>
                    </member>
                    <member>
                        <name>IV</name>
                        <value>
                            <string>GTYM521PL98THB72156HTBD5H</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.