WS_PayByCC


Click here for a complete list of operations.

EmailPaymentReceiptByInvoiceString

Generate and email Credit Card Payment Receipt. Company Code [2 characters] Email Address Payment Date Customer Account [Customer Number - Site Number] Phone Number Fax Number Payment Total Payment Method [E.g. 'Paid By Mastercard ending with 1111'] Authorization Code Header information for Paid Invoices. [In a string] Receipt header [E.g. Account Name, Phone Number etc.] Receipt footer [E.g. Company Name, Address etc.] Return True if email sent successfully, returns False if send failed.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sCompCode:
sEmailAddress:
sPaymentDate:
sAccountNo:
sPhone:
sFax:
sTotalAmount:
sCCFeeText:
sCCFeeString:
applyCCProcFee:
sPaymentMethod:
sAuthenticationCode:
strPaidInvoice:
sHeader:
sFooter:

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 /TruxWeb/WSAcct_PayByCreditCard/WS_PayByCreditCard.asmx HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.trux.com/EmailPaymentReceiptByInvoiceString"

<?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:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap:Header>
  <soap:Body>
    <EmailPaymentReceiptByInvoiceString xmlns="http://www.trux.com">
      <sCompCode>string</sCompCode>
      <sEmailAddress>string</sEmailAddress>
      <sPaymentDate>string</sPaymentDate>
      <sAccountNo>string</sAccountNo>
      <sPhone>string</sPhone>
      <sFax>string</sFax>
      <sTotalAmount>string</sTotalAmount>
      <sCCFeeText>string</sCCFeeText>
      <sCCFeeString>string</sCCFeeString>
      <applyCCProcFee>boolean</applyCCProcFee>
      <sPaymentMethod>string</sPaymentMethod>
      <sAuthenticationCode>string</sAuthenticationCode>
      <strPaidInvoice>string</strPaidInvoice>
      <sHeader>string</sHeader>
      <sFooter>string</sFooter>
    </EmailPaymentReceiptByInvoiceString>
  </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>
    <EmailPaymentReceiptByInvoiceStringResponse xmlns="http://www.trux.com">
      <EmailPaymentReceiptByInvoiceStringResult>boolean</EmailPaymentReceiptByInvoiceStringResult>
    </EmailPaymentReceiptByInvoiceStringResponse>
  </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 /TruxWeb/WSAcct_PayByCreditCard/WS_PayByCreditCard.asmx HTTP/1.1
Host: trux.organicdiversion.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:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap12:Header>
  <soap12:Body>
    <EmailPaymentReceiptByInvoiceString xmlns="http://www.trux.com">
      <sCompCode>string</sCompCode>
      <sEmailAddress>string</sEmailAddress>
      <sPaymentDate>string</sPaymentDate>
      <sAccountNo>string</sAccountNo>
      <sPhone>string</sPhone>
      <sFax>string</sFax>
      <sTotalAmount>string</sTotalAmount>
      <sCCFeeText>string</sCCFeeText>
      <sCCFeeString>string</sCCFeeString>
      <applyCCProcFee>boolean</applyCCProcFee>
      <sPaymentMethod>string</sPaymentMethod>
      <sAuthenticationCode>string</sAuthenticationCode>
      <strPaidInvoice>string</strPaidInvoice>
      <sHeader>string</sHeader>
      <sFooter>string</sFooter>
    </EmailPaymentReceiptByInvoiceString>
  </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>
    <EmailPaymentReceiptByInvoiceStringResponse xmlns="http://www.trux.com">
      <EmailPaymentReceiptByInvoiceStringResult>boolean</EmailPaymentReceiptByInvoiceStringResult>
    </EmailPaymentReceiptByInvoiceStringResponse>
  </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 /TruxWeb/WSAcct_PayByCreditCard/WS_PayByCreditCard.asmx/EmailPaymentReceiptByInvoiceString?sCompCode=string&sEmailAddress=string&sPaymentDate=string&sAccountNo=string&sPhone=string&sFax=string&sTotalAmount=string&sCCFeeText=string&sCCFeeString=string&applyCCProcFee=string&sPaymentMethod=string&sAuthenticationCode=string&strPaidInvoice=string&sHeader=string&sFooter=string HTTP/1.1
Host: trux.organicdiversion.com

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

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.trux.com">boolean</boolean>

HTTP POST

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

POST /TruxWeb/WSAcct_PayByCreditCard/WS_PayByCreditCard.asmx/EmailPaymentReceiptByInvoiceString HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sCompCode=string&sEmailAddress=string&sPaymentDate=string&sAccountNo=string&sPhone=string&sFax=string&sTotalAmount=string&sCCFeeText=string&sCCFeeString=string&applyCCProcFee=string&sPaymentMethod=string&sAuthenticationCode=string&strPaidInvoice=string&sHeader=string&sFooter=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.trux.com">boolean</boolean>