AddCardTag

Add a Tag Name and Tag Value to a card identified by tracking number. This is for the client to mark the card with an identifier without having to move the card to a different program (for client’s with multiple card programs).

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

tagName

string, 1-50 characters, required

tagName with which cards can be tagged

tagValue

string, 1-255 characters, required

tagValue value that belong to a tagName

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"?>
<methodCall>
    <methodName type="xs:string">AddCardTag</methodName>
    <params>
        <param>
            <value>
                <string>0001001111</string>
            </value>
        </param>
        <param>
            <value>
                <string>e1111100012451109bda4ade3aa6113d</string>
            </value>
        </param>
        <param>
            <value>
                <string>543219000000321</string>
            </value>
        </param>
        <param>
            <value>
                <string>tag_name</string>
            </value>
        </param>
        <param>
            <value>
                <string>tag_Value</string>
            </value>
        </param>
        <param>
            <value>
                <string>c7f7b112-b6ce-41c8-89c5-e5b18fc5211a</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20180718T10:34:04</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>20AC938B3F2007EBBC4915AEF201111DF6A018BC</string>
            </value>
        </param>
    </params>
</methodCall>

Response

STATUS200 OK

Schema

terminalID

string

Echo

customerReference

string

Echo

trackingNumber

string

Echo

clientTransactionID

string

Echo

serverTransactionID

string

Transaction ID generated by Paymentology

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>c7f7b112-b6ce-41c8-89c5-e5b18fc5211a</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>0001001111</string>
                        </value>
                    </member>
                    <member>
                        <name>customerReference</name>
                        <value>
                            <string>e1111100012451109bda4ade3aa6113d</string>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>5D000111-C5AE-39B9-E111000F1C11111A</string>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>543219000000321</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

BACK TO CARD API MENU

Request

Path parameters

Response

STATUS200 OK

Schema

Are you ready to use our APIs