1. Home
  2. Corporate Node
  3. SOAP requests
  4. endSeriesPayment

endSeriesPayment

Operation endSeriesPayment ends series payment – new payment requests will be refused (attention: already sent payment requests won’t be undone).

Example SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:endSeriesPayment>
   <seriesId>0B3LCA6254A12E5GEB0MF4F6LH</seriesId>
  </ns:endSeriesPayment>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:endSeriesPaymentResponse>
   <return>
    <requestStatus>SUCCESS</requestStatus>
    <requestStatusDescription>Request succeeded.</requestStatusDescription>
   </return>
  </ns:endSeriesPaymentResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request parameters:

ParameterTypeDescription
seriesIdstringidentifier of series payment, which is to be ended

Response parameters:

nametypedescription
requestStatusstringresult of request
requestStatusDescriptionstringstatus description

Possible errors:

ErrorDescription
ERR_INVALID_PASSWORDInvalid password
ERR_INVALID_TASK_IDInvalid task identifier – up to version 1.2
ERR_INVALID_SERIES_IDInvalid identifier of the series payment – from version 1.3
Was this article helpful to you? Yes No

How can we help?