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
string, 10 characters, required
The Paymentology issued terminal ID of the terminal requesting the transaction.
string, 1-20 characters, required
Profile number linked with this card.
string, 1-20 characters, required
The card number, sequence number or tracking number of the specified card.
date, required
The day when the card will be stopped.
integer, required
Stop Reason ID associated with the reason for stopping a card.
string, required
Any additional remarks describing the stop.
string, 1-255 charcters, required
Transaction ID number generated by the calling client.
date, required
Transaction date generated by the calling client.
string, required
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
STATUS200 OK
Schema
string
Echo of incoming value.
string
Echo of incoming value.
string
The number of the updated card.
date
Echo of incoming value.
integer
Echo of incoming value.
string
Echo of incoming value.
string
Echo of incoming value.
string
Transaction ID generated by Paymentology.
integer
Status code indicating transaction result.
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>