WS_PayByCC

Click here for a complete list of operations.

EmailPaymentReceipt

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 an ArrayList] Receipt header [E.g. Account Name, Phone Number etc.] Receipt footer [E.g. Company Name, Address etc.] Customer Number Site Number Return True if email sent successfully, returns False if send failed.

Test

The test form is only available for requests from the local machine.

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/EmailPaymentReceipt"

<?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>
    <EmailPaymentReceipt 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>
      <alPaidInvoice>
        <anyType />
        <anyType />
      </alPaidInvoice>
      <sHeader>string</sHeader>
      <sFooter>string</sFooter>
      <sCust>string</sCust>
      <sSite>string</sSite>
    </EmailPaymentReceipt>
  </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>
    <EmailPaymentReceiptResponse xmlns="http://www.trux.com">
      <EmailPaymentReceiptResult>boolean</EmailPaymentReceiptResult>
    </EmailPaymentReceiptResponse>
  </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>
    <EmailPaymentReceipt 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>
      <alPaidInvoice>
        <anyType />
        <anyType />
      </alPaidInvoice>
      <sHeader>string</sHeader>
      <sFooter>string</sFooter>
      <sCust>string</sCust>
      <sSite>string</sSite>
    </EmailPaymentReceipt>
  </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>
    <EmailPaymentReceiptResponse xmlns="http://www.trux.com">
      <EmailPaymentReceiptResult>boolean</EmailPaymentReceiptResult>
    </EmailPaymentReceiptResponse>
  </soap12:Body>
</soap12:Envelope>