WS_PayByCC Web Service

WS_PayByCC

Click here for a complete list of operations.

GetCurrentCreditCard

Get current Credit Card Information for a Customer Account.

Company Code [2 characters] User ID [10 characters unpadded] Customer Number [10 digits, unpadded] Site Number [4 digits, unpadded, Use '0' if Customer is Consolidated] Returns current Credit Card Details with the following fields: Field NameDescription CC02_CUSTCustomer Number [Max 10 characters] CC02_SITESite Number [Max 4 characters] CC02_TYPECredit Card Types defined in Code Maintenance CC02_NUMBERCredit Card Number [16 digits] CC02_EXPMOCredit Card Expiration Month [2 digits] CC02_EXPYECredit Card Expiration Year [2 digits] CC02_CVV2CVV2 Number [The CVV2 Number is not stored] CC02_HFNAMECard Holder First Name CC02_HLNAMECard Holder Last Name CC02_HADDAddress CC02_HCITYCity CC02_HSTATState\Province [2 characters] CC02_HZIPZip\Postal Code CC02_HCOUNCountry [2 characters] CC02_HPHONPhone Number [9 digits] CC02_HEMAILEmail Address CC02_ACTIVEActive Flag CC02_CHRGTYPECharge Type ['V' = Variable Recurring, 'F' = Fixed Recurring, 'S' = Single Charge] CC02_IDTRUX Internal Reference CC02_ROUTNUMBanking Route Number CC02_ACCTYPEBank Account Type [0 = Checking, 1 = Saving] CC02_BANKNBank Number CC02_LICNUMDriver's License Number CC02_LICSTATDriver's License State [2 characters] CC02_DOBDate of Birth ['mm/dd/yyyy'] CC02_ACCNAMEAccount Name CC02_TOKENCard Token

Test

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

Parameter	Value
sLoginComp:
sLoginUser:
cust:
site:

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

<?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>
    <GetCurrentCreditCard xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <sLoginUser>string</sLoginUser>
      <cust>string</cust>
      <site>string</site>
    </GetCurrentCreditCard>
  </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>
    <GetCurrentCreditCardResponse xmlns="http://www.trux.com">
      <GetCurrentCreditCardResult>xmlxml</GetCurrentCreditCardResult>
    </GetCurrentCreditCardResponse>
  </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>
    <GetCurrentCreditCard xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <sLoginUser>string</sLoginUser>
      <cust>string</cust>
      <site>string</site>
    </GetCurrentCreditCard>
  </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>
    <GetCurrentCreditCardResponse xmlns="http://www.trux.com">
      <GetCurrentCreditCardResult>xmlxml</GetCurrentCreditCardResult>
    </GetCurrentCreditCardResponse>
  </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/GetCurrentCreditCard?sLoginComp=string&sLoginUser=string&cust=string&site=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"?>
<DataTable xmlns="http://www.trux.com">xmlxml</DataTable>

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/GetCurrentCreditCard HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sLoginComp=string&sLoginUser=string&cust=string&site=string

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

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