WS_PayByCC
Web Service that allows users to pay by credit card
The following operations are supported. For a formal definition, please review the Service Description.
-
AddNewACHUrl
Add new ACH card for Global Payment Company Code [2 characters] Post URLTrue or False -
AddNewCreditCard
Add a new credit card to the specific customer / site 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]Return Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
AddNewCreditCardToken
Add new credit card using token 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]Return Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
AddNewCreditCardUrl
Add new credit card for Global Payment Company Code [2 characters] Post URLTrue or False -
ApplyCreditCardProcessingFeeToCustomer
Determines if the credit card processing fee applies to the current customer/site Company Code [2 characters] Customer Number Site NumberTrue if the credit card processing fee applies to the current customer -
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 NumberReturn True if email sent successfully, returns False if send failed. -
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. -
GetACHInfo
Gets active ACH information associated with the 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 ACH list with the following fields: CC02_BANKN Bank Number CC02_NUMBER Card Number CC02_TOKEN Card Token
Field Name Description -
GetCompanyGateway
Get gateway of specified company Company Code [2 characters]True or False -
GetConvenienceFee
Get global payment convenience fee Company Code [2 characters] Card Token Payment AmountTrue or False -
GetCreditCardType
Get Credit Card Type defined in Code Maintenance. Company Code [2 characters]Returns listing of Credit Card Types with following fields: CCCODES_CODE Credit Card Type Code [2 characters] CCCODES_DESC Credit Card Type Description CCCODES_ACTIVE Active Flag CCCODES_TYPE Card Type [C = Credit Card, P = Preauthorized Bank Card]
Field Name Description -
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: CC02_CUST Customer Number [Max 10 characters] CC02_SITE Site Number [Max 4 characters] CC02_TYPE Credit Card Types defined in Code Maintenance CC02_NUMBER Credit Card Number [16 digits] CC02_EXPMO Credit Card Expiration Month [2 digits] CC02_EXPYE Credit Card Expiration Year [2 digits] CC02_CVV2 CVV2 Number [The CVV2 Number is not stored] CC02_HFNAME Card Holder First Name CC02_HLNAME Card Holder Last Name CC02_HADD Address CC02_HCITY City CC02_HSTAT State\Province [2 characters] CC02_HZIP Zip\Postal Code CC02_HCOUN Country [2 characters] CC02_HPHON Phone Number [9 digits] CC02_HEMAIL Email Address CC02_ACTIVE Active Flag CC02_CHRGTYPE Charge Type ['V' = Variable Recurring, 'F' = Fixed Recurring, 'S' = Single Charge] CC02_ID TRUX Internal Reference CC02_ROUTNUM Banking Route Number CC02_ACCTYPE Bank Account Type [0 = Checking, 1 = Saving] CC02_BANKN Bank Number CC02_LICNUM Driver's License Number CC02_LICSTAT Driver's License State [2 characters] CC02_DOB Date of Birth ['mm/dd/yyyy'] CC02_ACCNAME Account Name CC02_TOKEN Card Token
Field Name Description -
GetStatesProvincesForComp
Get listing of States and Provinces Company Code [2 characters] User ID [10 characters unpadded]Returns listing of States and Provinces SY08_CODE Code [2 characters] SY08_NAME Name SY08_COUN Country
Field Name Description -
GetUnpaidInvoicesForComp
Get listing of header information, for Invoices with outstanding balances, 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 listing of unpaid Invoices with the following fields: DM01_ID TRUX Internal Reference DM01_INVC Invoice Number [Max 10 digits or 'OA'] INVOICEDATE Invoice Date BALANCE Invoice Balance DM01_CUST Customer Number [Max 10 characters] DM01_SITE Site Number [Max 4 characters] APPLIED Amount Applied to Invoice
Field Name Description -
PayByAchOnFile
Pay selected Invoices using ACH associated with the 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] Invoice Numbers to be paid [In an ArrayList]Returns Gateway Transaction ID ['0' means failed transaction] -
PayByAchOnFileByInvoiceString
Pay selected Invoices using the current ACH Card associated with the 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] Invoice Numbers to be paid [In a string]Returns Gateway Transaction ID ['0' means failed transaction] -
PayByCreditCardOnFile
Pay selected Invoices using the current Credit Card associated with the 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] Invoice Numbers to be paid [In an ArrayList] CVV2 Number [The CVV2 Number is not stored]Returns Gateway Transaction ID ['0' means failed transaction] -
PayByCreditCardOnFileByInvoiceString
Pay selected Invoices using the current Credit Card associated with the 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] Invoice Numbers to be paid [In a string] CVV2 Number [The CVV2 Number is not stored]Returns Gateway Transaction ID ['0' means failed transaction] -
PayByNewAch
Pay selected Invoices using the provided ACH 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] 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 an ArrayList] Card Number Bank Name Bank Account Type [0 = Checking, 1 = Saving] Banking Route Number Date of Birth License Number License StateReturn Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
PayByNewAchByInvoiceString
Pay selected Invoices using the provided ACH 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] 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] Card Number Bank Name Bank Account Type [0 = Checking, 1 = Saving] Banking Route Number Date of Birth License Number License StateReturn Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
PayByNewAchToken
Pay selected Invoices using the provided ACH 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] 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 an ArrayList] Card Number Bank Name Bank Account Type [0 = Checking, 1 = Saving] Banking Route Number Date of Birth License Number License StateReturn Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
PayByNewCreditCard
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 an ArrayList]Return Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
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] -
PayByNewCreditCardToken
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 an ArrayList]Return Message ['TRUE - xxx' means the successful transaction , 'FALSE - xxx' means the failed transaction followed by reason/gateway resonse] -
PostPayment
Post payment to selected Invoices Company Code [2 characters] External Company Reference [10 characters] Customer Number [int] Site Number [int] Invoice Number to be paid Payment Amount Payment Type Codes defined in Code Maintenance Payment Date Payment Reference [50 characters]Response code: PaymentSuccess = 1 PaymentDuplicated = 2 InvoiceNotFound = 3 CustomerNotFound = 4 SiteNotFound = 5 InvoicePaid = 6 Exception = 7 NotAuthorized = 8 InvalidPaymentDate = 9 CompanyReferenceNotFound = 10 InvalidPaymentType = 11