Service Web Service

Service

Click here for a complete list of operations.

SendPaymentSMS

Test

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

Parameter	Value
Token:
Username:
BusinessName:
AccountNumber:
Description:
TotalAmountDue:
BillToName:
BillToAddress1:
BillToCity:
BillToState:
BillToZip:
BillToCellPhone:
BillToAddress2:
BusinessAddress1:
BusinessAddress2:
BusinessCity:
BusinessState:
BusinessZip:
BusinessPhone:
BusinessEmail:
AccountNumber2:
InvoiceID:
StatementDate:
Subtotal:
Tax:
ConvenienceFee:
ScheduledDate:
ExpirationDate:
SMSMessage:

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 /Service.asmx HTTP/1.1
Host: api.everyware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wsclientapi.everyware.com/SendPaymentSMS"

<?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>
    <SendPaymentSMS xmlns="http://wsclientapi.everyware.com/">
      <Token>string</Token>
      <Username>string</Username>
      <BusinessName>string</BusinessName>
      <AccountNumber>string</AccountNumber>
      <Description>string</Description>
      <TotalAmountDue>string</TotalAmountDue>
      <BillToName>string</BillToName>
      <BillToAddress1>string</BillToAddress1>
      <BillToCity>string</BillToCity>
      <BillToState>string</BillToState>
      <BillToZip>string</BillToZip>
      <BillToCellPhone>string</BillToCellPhone>
      <BillToAddress2>string</BillToAddress2>
      <BusinessAddress1>string</BusinessAddress1>
      <BusinessAddress2>string</BusinessAddress2>
      <BusinessCity>string</BusinessCity>
      <BusinessState>string</BusinessState>
      <BusinessZip>string</BusinessZip>
      <BusinessPhone>string</BusinessPhone>
      <BusinessEmail>string</BusinessEmail>
      <AccountNumber2>string</AccountNumber2>
      <InvoiceID>string</InvoiceID>
      <StatementDate>string</StatementDate>
      <Subtotal>string</Subtotal>
      <Tax>string</Tax>
      <ConvenienceFee>string</ConvenienceFee>
      <ScheduledDate>string</ScheduledDate>
      <ExpirationDate>string</ExpirationDate>
      <SMSMessage>string</SMSMessage>
    </SendPaymentSMS>
  </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>
    <SendPaymentSMSResponse xmlns="http://wsclientapi.everyware.com/">
      <SendPaymentSMSResult>string</SendPaymentSMSResult>
    </SendPaymentSMSResponse>
  </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 /Service.asmx HTTP/1.1
Host: api.everyware.com
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>
    <SendPaymentSMS xmlns="http://wsclientapi.everyware.com/">
      <Token>string</Token>
      <Username>string</Username>
      <BusinessName>string</BusinessName>
      <AccountNumber>string</AccountNumber>
      <Description>string</Description>
      <TotalAmountDue>string</TotalAmountDue>
      <BillToName>string</BillToName>
      <BillToAddress1>string</BillToAddress1>
      <BillToCity>string</BillToCity>
      <BillToState>string</BillToState>
      <BillToZip>string</BillToZip>
      <BillToCellPhone>string</BillToCellPhone>
      <BillToAddress2>string</BillToAddress2>
      <BusinessAddress1>string</BusinessAddress1>
      <BusinessAddress2>string</BusinessAddress2>
      <BusinessCity>string</BusinessCity>
      <BusinessState>string</BusinessState>
      <BusinessZip>string</BusinessZip>
      <BusinessPhone>string</BusinessPhone>
      <BusinessEmail>string</BusinessEmail>
      <AccountNumber2>string</AccountNumber2>
      <InvoiceID>string</InvoiceID>
      <StatementDate>string</StatementDate>
      <Subtotal>string</Subtotal>
      <Tax>string</Tax>
      <ConvenienceFee>string</ConvenienceFee>
      <ScheduledDate>string</ScheduledDate>
      <ExpirationDate>string</ExpirationDate>
      <SMSMessage>string</SMSMessage>
    </SendPaymentSMS>
  </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>
    <SendPaymentSMSResponse xmlns="http://wsclientapi.everyware.com/">
      <SendPaymentSMSResult>string</SendPaymentSMSResult>
    </SendPaymentSMSResponse>
  </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 /Service.asmx/SendPaymentSMS?Token=string&Username=string&BusinessName=string&AccountNumber=string&Description=string&TotalAmountDue=string&BillToName=string&BillToAddress1=string&BillToCity=string&BillToState=string&BillToZip=string&BillToCellPhone=string&BillToAddress2=string&BusinessAddress1=string&BusinessAddress2=string&BusinessCity=string&BusinessState=string&BusinessZip=string&BusinessPhone=string&BusinessEmail=string&AccountNumber2=string&InvoiceID=string&StatementDate=string&Subtotal=string&Tax=string&ConvenienceFee=string&ScheduledDate=string&ExpirationDate=string&SMSMessage=string HTTP/1.1
Host: api.everyware.com

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://wsclientapi.everyware.com/">string</string>

HTTP POST

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

POST /Service.asmx/SendPaymentSMS HTTP/1.1
Host: api.everyware.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Token=string&Username=string&BusinessName=string&AccountNumber=string&Description=string&TotalAmountDue=string&BillToName=string&BillToAddress1=string&BillToCity=string&BillToState=string&BillToZip=string&BillToCellPhone=string&BillToAddress2=string&BusinessAddress1=string&BusinessAddress2=string&BusinessCity=string&BusinessState=string&BusinessZip=string&BusinessPhone=string&BusinessEmail=string&AccountNumber2=string&InvoiceID=string&StatementDate=string&Subtotal=string&Tax=string&ConvenienceFee=string&ScheduledDate=string&ExpirationDate=string&SMSMessage=string

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://wsclientapi.everyware.com/">string</string>