RECURRING Web Service

RECURRING

Click here for a complete list of operations.

CREATE_RECURRING_CUSTOMER

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
M_ID:
M_KEY:
CUSTOMER_TYPE:
FIRST_NAME:
LAST_NAME:
ADDRESS:
CITY:
STATE:
ZIP:
COUNTRY:
TELEPHONE:
FAX:
EMAIL_ADDRESS:
SHIPPING_RECIPIENT:
SHIPPING_ADDRESS:
SHIPPING_CITY:
SHIPPING_STATE:
SHIPPING_ZIP:
SHIPPING_COUNTRY:
HOLD:
HOLD_MESSAGE:
REFERENCE:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /web_services/wsVTextensions/recurring.asmx HTTP/1.1
Host: gateway.sagepayments.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "wsVTExtensions/CREATE_RECURRING_CUSTOMER"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CREATE_RECURRING_CUSTOMER xmlns="wsVTExtensions">
      <M_ID>string</M_ID>
      <M_KEY>string</M_KEY>
      <CUSTOMER_TYPE>int</CUSTOMER_TYPE>
      <FIRST_NAME>string</FIRST_NAME>
      <LAST_NAME>string</LAST_NAME>
      <ADDRESS>string</ADDRESS>
      <CITY>string</CITY>
      <STATE>string</STATE>
      <ZIP>string</ZIP>
      <COUNTRY>string</COUNTRY>
      <TELEPHONE>string</TELEPHONE>
      <FAX>string</FAX>
      <EMAIL_ADDRESS>string</EMAIL_ADDRESS>
      <SHIPPING_RECIPIENT>string</SHIPPING_RECIPIENT>
      <SHIPPING_ADDRESS>string</SHIPPING_ADDRESS>
      <SHIPPING_CITY>string</SHIPPING_CITY>
      <SHIPPING_STATE>string</SHIPPING_STATE>
      <SHIPPING_ZIP>string</SHIPPING_ZIP>
      <SHIPPING_COUNTRY>string</SHIPPING_COUNTRY>
      <HOLD>int</HOLD>
      <HOLD_MESSAGE>string</HOLD_MESSAGE>
      <REFERENCE>string</REFERENCE>
    </CREATE_RECURRING_CUSTOMER>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CREATE_RECURRING_CUSTOMERResponse xmlns="wsVTExtensions">
      <CREATE_RECURRING_CUSTOMERResult>
        <xsd:schema>schema</xsd:schema>xml</CREATE_RECURRING_CUSTOMERResult>
    </CREATE_RECURRING_CUSTOMERResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /web_services/wsVTextensions/recurring.asmx HTTP/1.1
Host: gateway.sagepayments.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CREATE_RECURRING_CUSTOMER xmlns="wsVTExtensions">
      <M_ID>string</M_ID>
      <M_KEY>string</M_KEY>
      <CUSTOMER_TYPE>int</CUSTOMER_TYPE>
      <FIRST_NAME>string</FIRST_NAME>
      <LAST_NAME>string</LAST_NAME>
      <ADDRESS>string</ADDRESS>
      <CITY>string</CITY>
      <STATE>string</STATE>
      <ZIP>string</ZIP>
      <COUNTRY>string</COUNTRY>
      <TELEPHONE>string</TELEPHONE>
      <FAX>string</FAX>
      <EMAIL_ADDRESS>string</EMAIL_ADDRESS>
      <SHIPPING_RECIPIENT>string</SHIPPING_RECIPIENT>
      <SHIPPING_ADDRESS>string</SHIPPING_ADDRESS>
      <SHIPPING_CITY>string</SHIPPING_CITY>
      <SHIPPING_STATE>string</SHIPPING_STATE>
      <SHIPPING_ZIP>string</SHIPPING_ZIP>
      <SHIPPING_COUNTRY>string</SHIPPING_COUNTRY>
      <HOLD>int</HOLD>
      <HOLD_MESSAGE>string</HOLD_MESSAGE>
      <REFERENCE>string</REFERENCE>
    </CREATE_RECURRING_CUSTOMER>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CREATE_RECURRING_CUSTOMERResponse xmlns="wsVTExtensions">
      <CREATE_RECURRING_CUSTOMERResult>
        <xsd:schema>schema</xsd:schema>xml</CREATE_RECURRING_CUSTOMERResult>
    </CREATE_RECURRING_CUSTOMERResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /web_services/wsVTextensions/recurring.asmx/CREATE_RECURRING_CUSTOMER?M_ID=string&M_KEY=string&CUSTOMER_TYPE=string&FIRST_NAME=string&LAST_NAME=string&ADDRESS=string&CITY=string&STATE=string&ZIP=string&COUNTRY=string&TELEPHONE=string&FAX=string&EMAIL_ADDRESS=string&SHIPPING_RECIPIENT=string&SHIPPING_ADDRESS=string&SHIPPING_CITY=string&SHIPPING_STATE=string&SHIPPING_ZIP=string&SHIPPING_COUNTRY=string&HOLD=string&HOLD_MESSAGE=string&REFERENCE=string HTTP/1.1
Host: gateway.sagepayments.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="wsVTExtensions">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /web_services/wsVTextensions/recurring.asmx/CREATE_RECURRING_CUSTOMER HTTP/1.1
Host: gateway.sagepayments.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

M_ID=string&M_KEY=string&CUSTOMER_TYPE=string&FIRST_NAME=string&LAST_NAME=string&ADDRESS=string&CITY=string&STATE=string&ZIP=string&COUNTRY=string&TELEPHONE=string&FAX=string&EMAIL_ADDRESS=string&SHIPPING_RECIPIENT=string&SHIPPING_ADDRESS=string&SHIPPING_CITY=string&SHIPPING_STATE=string&SHIPPING_ZIP=string&SHIPPING_COUNTRY=string&HOLD=string&HOLD_MESSAGE=string&REFERENCE=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="wsVTExtensions">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>