WS_PayByCC Web Service

WS_PayByCC

Click here for a complete list of operations.

PayByNewCreditCardByInvoiceString

Pay selected Invoices using the provided Credit Card information.

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] Credit Card Types defined in Code Maintenance Credit Card Number [16 digits] Credit Card Expiration Month [2 digits] Credit Card Expiration Year [2 digits] CVV2 Number [The CVV2 Number is not stored] Charge Type ['V' = Variable Recurring, 'F' = Fixed Recurring, 'S' = Single Charge] First Name of Card Holder Last Name of Card Holder Address of Card Holder City of Card Holder State or Province of Card Holder Country of Card Holder Postal or Zip Code of Card Holder Phone Number of Card Holder Email of Card Holder Active flag ['True'= Overwrite Existing Card (or Save As New Card if none), 'False'= Save As Historic Card] Invoice Numbers to be paid [In a string] Return Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse]

Test

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

Parameter	Value
sLoginComp:
sLoginUser:
cust:
site:
cardType:
cardNumber:
expirationMonth:
expirationYear:
cvv2Data:
chargeType:
firstName:
lastName:
address:
city:
stateProv:
country:
postalCode:
phoneNumber:
email:
bActive:
strSelectedInvc:

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

<?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>
    <PayByNewCreditCardByInvoiceString xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <sLoginUser>string</sLoginUser>
      <cust>string</cust>
      <site>string</site>
      <cardType>string</cardType>
      <cardNumber>string</cardNumber>
      <expirationMonth>string</expirationMonth>
      <expirationYear>string</expirationYear>
      <cvv2Data>string</cvv2Data>
      <chargeType>string</chargeType>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <stateProv>string</stateProv>
      <country>string</country>
      <postalCode>string</postalCode>
      <phoneNumber>string</phoneNumber>
      <email>string</email>
      <bActive>boolean</bActive>
      <strSelectedInvc>string</strSelectedInvc>
    </PayByNewCreditCardByInvoiceString>
  </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>
    <PayByNewCreditCardByInvoiceStringResponse xmlns="http://www.trux.com">
      <PayByNewCreditCardByInvoiceStringResult>string</PayByNewCreditCardByInvoiceStringResult>
    </PayByNewCreditCardByInvoiceStringResponse>
  </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>
    <PayByNewCreditCardByInvoiceString xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <sLoginUser>string</sLoginUser>
      <cust>string</cust>
      <site>string</site>
      <cardType>string</cardType>
      <cardNumber>string</cardNumber>
      <expirationMonth>string</expirationMonth>
      <expirationYear>string</expirationYear>
      <cvv2Data>string</cvv2Data>
      <chargeType>string</chargeType>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <stateProv>string</stateProv>
      <country>string</country>
      <postalCode>string</postalCode>
      <phoneNumber>string</phoneNumber>
      <email>string</email>
      <bActive>boolean</bActive>
      <strSelectedInvc>string</strSelectedInvc>
    </PayByNewCreditCardByInvoiceString>
  </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>
    <PayByNewCreditCardByInvoiceStringResponse xmlns="http://www.trux.com">
      <PayByNewCreditCardByInvoiceStringResult>string</PayByNewCreditCardByInvoiceStringResult>
    </PayByNewCreditCardByInvoiceStringResponse>
  </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/PayByNewCreditCardByInvoiceString?sLoginComp=string&sLoginUser=string&cust=string&site=string&cardType=string&cardNumber=string&expirationMonth=string&expirationYear=string&cvv2Data=string&chargeType=string&firstName=string&lastName=string&address=string&city=string&stateProv=string&country=string&postalCode=string&phoneNumber=string&email=string&bActive=string&strSelectedInvc=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"?>
<string xmlns="http://www.trux.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 /TruxWeb/WSAcct_PayByCreditCard/WS_PayByCreditCard.asmx/PayByNewCreditCardByInvoiceString 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&cardType=string&cardNumber=string&expirationMonth=string&expirationYear=string&cvv2Data=string&chargeType=string&firstName=string&lastName=string&address=string&city=string&stateProv=string&country=string&postalCode=string&phoneNumber=string&email=string&bActive=string&strSelectedInvc=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://www.trux.com">string</string>