RetireCard

Permanently disable a card so that it is no longer returned for the customer reference in the ListCards method.

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 for the card to stop

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">RetireCard</methodName>
    <params>
        <param>
            <value>
                <string>0008866376</string>
            </value>
        </param>
        <param>
            <value>
                <string>TEST_CUSTOMER</string>
            </value>
        </param>
        <param>
            <value>
                <string>638654700000008</string>
            </value>
        </param>
        <param>
            <value>
                <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20160525T00:00:00</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>3E8C52A54D52A41BBA6123838BAD71E3E0F7BE3B</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 number generated by Paymentology

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>clientTransactionID</name>
                        <value>
                            <string>d89d6df6-4e14-45a5-a32c-217c7175dfdb</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>0008866376</string>
                        </value>
                    </member>
                    <member>
                        <name>customerReference</name>
                        <value>
                            <string>TEST_CUSTOMER</string>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>76E03B79-155D-0028-9DF8E175D8F05BA3</string>
                        </value>
                    </member>
                    <member>
                        <name>trackingNumber</name>
                        <value>
                            <string>638654700000008</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