RetireCard

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

Request Path Parameters

Parameter	type	Limits	required	Description
terminalID	String	10 characters	✓	The Paymentology issued terminal id of the terminal requesting the transaction
customerReference	String	1-255 characters	✓	Customer reference linked with this card
trackingNumber	String	1-20 characters	✓	Tracking number for the card to stop
transactionID	String	1-255 characters	✓	A unique identifier generated by the client, which must not be duplicated over time.
transactionDate	Date		✓	Transaction date generated by the calling client
checksum	String		✓	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 Parameters

Field	type	Description
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>