CreateScheduledStop

Schedules the stop of the card on the date of the parameter. There can only be one active scheduled stop for a card.

Will return an error if the schedule already exists.

Request Path Parameters

Parameter	type	Limits	required	Description
terminalID	String	10 characters	✓	The Paymentology issued terminal ID of the terminal requesting the transaction.
profileNumber	String	1-20 characters	✓	Profile number linked with this card.
cardIdenitifier	String	1-20 characters	✓	The card number, sequence number or tracking number of the specified card.
stopDate	Date		✓	The day when the card will be stopped.
stopReasonID	Integer		✓	Stop Reason ID associated with the reason for stopping a card.
stopComment	String		✓	Any additional remarks describing the stop.
transactionID	String	1-255 charcters	✓	Transaction ID number generated by the calling client.
transactionDate	Date		✓	Transaction date generated by the calling client.
checksum	String		✓	HMAC-SHA1 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>CreateScheduledStop</methodName>
   <params>
       <param>
           <value>
               <string>0765458925</string>
           </value>
       </param>
       <param>
           <value>
               <string>9765432072</string>
           </value>
       </param>
       <param>
           <value>
               <string>405432100000001</string>
           </value>
       </param>
       <param>
           <value>
               <dateTime.iso8601>20900531T12:00:00</dateTime.iso8601>
           </value>
       </param>
       <param>
           <value>
               <int>2</int>
           </value>
       </param>
       <param>
           <value>
               <string>lost</string>
           </value>
       </param>
        <param>
           <value>
               <string>T11112345561</string>
           </value>
       </param>
       <param>
           <value>
               <dateTime.iso8601>20240531T12:00:00</dateTime.iso8601>
           </value>
       </param>
       <param>
           <value>
               <string>f7d1e917fc3d5be3c5f3775hjklg67890e30e50227d675014881a59b5b03a616</string>
           </value>
       </param>
   </params>
</methodCall>

Response Parameters

Parameter	type	Description
terminalID	String	Echo of incoming value.
profileNumber	String	Echo of incoming value.
cardNumber	String	The number of the updated card.
stopDate	Date	Echo of incoming value.
stopReasonID	Integer	Echo of incoming value.
stopComment	String	Echo of incoming value.
clientTransactionID	String	Echo of incoming value.
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>T11112345561</string>
                        </value>
                    </member>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>terminalID</name>
                        <value>
                            <string>0765458925</string>
                        </value>
                    </member>
                    <member>
                        <name>stopComment</name>
                        <value>
                            <string>lost</string>
                        </value>
                    </member>
                    <member>
                        <name>stopDate</name>
                        <value>
                            <dateTime.iso8601>20900531T12:00:00</dateTime.iso8601>
                        </value>
                    </member>
                    <member>
                        <name>profileNumber</name>
                        <value>
                            <string>9765432072</string>
                        </value>
                    </member>
                    <member>
                        <name>cardNumber</name>
                        <value>
                            <string>4198765757004528</string>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                    <member>
                        <name>serverTransactionID</name>
                        <value>
                            <string>9094699072-f7d1e917fc3d5be3c5f3775hjklg67890e30e50227d675014881a59b5b03a616</string>
                        </value>
                    </member>
                    <member>
                        <name>stopReasonID</name>
                        <value>
                            <int>2</int>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>