Transact3
SmartPayments - ePayment Web Service
The following operations are supported. For a formal definition, please review the Service Description.
-
GenerateCardToken
Generate Card Token - Reserved for later use.UserName : ID of authorized SecureDecrypt user making request Password : Password of authorized SecureDecrypt user making request CardNumber : Card Number to tokenize ExtData : Additional, device-specific data in XML format Returned Values <TokenResponse>
<Result></Result>
<Message></Message>
<Token>{Tokenized Card Number}</Token>
</TokenResponse> -
GetInfo
Retrieves information from the Web Service.
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Initialize | Setup | BatchInquiry | StatusCheck ExtData : Extended Data in XML, Valid Values are: TrainingMode : Training Mode: T or F -
ManageCardVault
Update Card VaultUserName : ID of authorized SecureDecrypt user making request Password : Password of authorized SecureDecrypt user making request Transaction : Operation to be performed: [Create | Update] CustomerPaymentInfoKey : For updates, required key of record to update. CardNumber : Card Number to tokenize ExpDate : Card expiration date NameOnCard : Cardholder name Street : Cardholder street address Zip : Cardholder zip code ExtData : Additional, device-specific data in XML format Returned Values <CardVaultResponse>
<Result></Result>
<Message></Message>
<Token></Token>
<CustomerPaymentInfoKey></CustomerPaymentInfoKey>
<ExpDate></ExpDate>
<NameOnCard></NameOnCard>
<Street></Street>
<Zip></Zip>
</CardVaultResponse> -
ProcessBatch
Process ePayment Batch Transaction.
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Capture PaymentType : ALL | CREDIT | DEBIT | EBT BatchID : BatchID Number BatchStatus : Batch Status PNRef : Reference Number Assigned by the payment gateway ExtData : Extended Data in XML, Valid Values are: TrainingMode : Training Mode: T or F -
ProcessCheck
Process ePayment Check Transactions.
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Auth | Sale | Return | Force | Void | Capture | CaptureAll CheckNum : Check Number TransitNum : Transit Number AccountNum : AccountNumber MICR : MICR NameOnCheck : NameOnCheck DL : Drivers License SS : Social Security StateCode : State Code of the Driver License CheckType : CheckType (Personal | Corporate | Government) Amount : Amount in DDDDD.CC format ExtData : Extended Data in XML, Valid Values are: Timeout : Timeout Value in Seconds (default=40) PNRef : Reference Number Assigned by the payment gateway Phone : Phone Number EMail : E-Mail Address RawMICR : Check RawMICR Data InvNum : Invoice Number TrainingMode : Training Mode: T or F AccountType : Account Type (Saving | Checking) CityOfAccount : City where the bank account is located BillToStreet : Street address of the billing address BillToCity : City of the billing address BillToState : State/Province of the billing address BillToPostalCode : Zip/Postal Code of the billing address BillToCountry : Country of the billing address -
ProcessCreditCard
Process ePayment Credit Card Transaction. (See result codes, below.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Auth | Sale | Return | Void | Force | Capture | RepeatSale | CaptureAll | Adjustment CardNum : Payment Card Number ExpDate : Payment Card Expiration Date in MMYY format MagData : Payment Card Track II Mag-Stripe Data NameOnCard : Cardholders Name Amount : Amount in DDDDD.CC format InvNum : Invoice Tracking Number PNRef : Reference Number Assigned by the payment gateway Zip : CardHolder's billing ZipCode used with AVS Street : CardHolder's billing Street Address used with AVS CVNum : CardHolder's Card Verification Number used with CV Check ExtData : Extended Data in XML. Valid input values are: CustomerIDAuthCode : Original Authorization Code EntryMode : CardNum source: Manual | MagneticStripe | ICC | Proximity CVPresence : CVNum presence: None | NotSubmitted | Submitted | Illegible | NotPresent CustCode : Customer Code used with Commercial Cards TipAmt : Tip Amount TaxAmt : Tax Amount used with Commercial Cards SequenceNum : Sequence Number used with Recurring Transactions SequenceCount : Sequene Count used with Recurring Transactions ServerID : Server ID Timeout : Timeout Value in Seconds (default=40) TrainingMode : Training Mode: T or F Force : Force Duplicates: T or F RegisterNum : Register Number PONum : Purhcase Order Number City : the City of the CardHolder's billing address BillPayment : Bill payment indicator: T or F Authentication : Verified by Visa and UCAF programs: | Invoice : Purchase Card Level III Fleet : Fleet card identification data Items : Item data support for Fuel IIAS_Indicator : (FSA/HRA support) Support for qualified healthcare purchase: T | F Partial_Indicator : (FSA/HRA support) Support for partial authorizations: T | F QHP_Amount : (FSA/HRA support) Optional qualified medical expenses (over the counter medical items) subtotal RX_Amount : (FSA/HRA support) Optional prescription/RX subtotal Vision_Amount : (FSA/HRA support) Optional Vision/Optical subtotal Dental_Amount : (FSA/HRA support) Optional Dental subtotal Clinical_Amount : (FSA/HRA support) Optional Clinical subtotal SecureFormat : Encryption format: SecureMag | SecureMagV2 | MagneSafeV1 | MagneSafeV2 SecurityInfo : Key Serial Number generated by secure card reader Track1 : Encrypted Track1 data Track2 : Encrypted Track2 data Result Code Value Description Success 0 Transaction was successful. Fail 1 Transaction failed. Reject 2 Transaction was rejected by processor. Unknown 99 Unknown Transaction Failure. DecryptionFailure 501 Unable to decrypt secure transaction due to invalid data or invalid decryption keys. UnregisteredKSID 502 Secure device's ID is not registered as a SecureLink device. InvalidSecureFormat 503 Unrecognized or missing SecureFormat in ExtData. InvalidSecureTrack1 504 Invalid or missing Track1 in ExtData. InvalidSecureTrack2 505 Invalid or missing Track2 in ExtData. InvalidSecurityInfo 506 Invalid or missing SecurityInfo in ExtData. NeedSecureLinkAccount 507 User is not authorized for SecureLink transactions NeedSecureLinkEULA 508 User has not yet signed the SecureLink license agreement. InvalidDecryptedTrack1 509 Track1 decrypted OK but is malformed. Causes: Invalid decryption keys or SecureFormat. InvalidDecryptedTrack2 510 Track2 decrypted OK but is malformed. Causes: Invalid decryption keys or SecureFormat. -
ProcessDebitCard
Process ePayment Debit Card Transactions. (For result codes, see ProcessCreditCard.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Auth | Sale | Return | Force | Capture | CaptureAll CardNum : Payment Card Number ExpDate : Payment Card Expiration Date in MMYY format MagData : Payment Card Track II Mag-Stripe Data NameOnCard : Cardholders Name Amount : Amount in DDDDD.CC format PIN : PIN Block Returned by Pin-Pad RegisterNum : Register Number Pin-Pad is Connected SureChargeAmt : Sure Charge Amount in DDDDD.CC format CashBackAmt : Cash Back Amount in DDDDD.CC format ExtData : Extended Data in XML. Valid input values are: Timeout : Timeout Value in Seconds (default=40) TrainingMode : Training Mode: T or F KeySerialNumber : Key Serial Number for DUKPT Settle : Transaction re-entry: processor specific settlement data SecureFormat : Encryption format: SecureMag | SecureMagV2 | MagneSafeV1 | MagneSafeV2 SecurityInfo : Key Serial Number generated by secure card reader Track1 : Encrypted Track1 data Track2 : Encrypted Track2 data -
ProcessEBTCard
Process ePayment EBT Card Transactions. (For result codes, see ProcessCreditCard.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : FoodStampSale | FoodStampReturn | CashBenefitSale | Capture | CaptureAll CardNum : Payment Card Number ExpDate : Payment Card Expiration Date in MMYY format MagData : Payment Card Track II Mag-Stripe Data NameOnCard : Cardholders Name Amount : Amount in DDDDD.CC format InvNum : Invoice Tracking Number PNRef : Reference Number Assigned by the payment gateway PIN : PIN Block Returned by Pin-Pad RegisterNum : Register Number Pin-Pad is Connected SureChargeAmt : Sure Charge Amount in DDDDD.CC format CashBackAmt : Cash Back Amount in DDDDD.CC format ExtData : Extended Data in XML. Valid input values are: Timeout : Timeout Value in Seconds (default=40) TrainingMode : Training Mode: T or F KeySerialNumber : Key Serial Number for DUKPT VoucherNumber : Voucher Serial Number Settle : Transaction re-entry: processor specific settlement data SecureFormat : Encryption format: SecureMag | SecureMagV2 | MagneSafeV1 | MagneSafeV2 SecurityInfo : Key Serial Number generated by secure card reader Track1 : Encrypted Track1 data Track2 : Encrypted Track2 data -
ProcessGiftCard
Process ePayment Gift Card Transaction. (For result codes, see ProcessCreditCard.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Activate | Deactivate | Refund | Redeem | Inquire | Reload CardNum : Payment Card Number ExpDate : Payment Card Expiration Date in MMYY format MagData : Payment Card Track II Mag-Stripe Data Amount : Amount in DDDDD.CC format InvNum : Invoice Tracking Number PNRef : Reference Number Assigned by the payment gateway ExtData : Extended Data in XML. Valid input values are: Timeout : Timeout Value in Seconds (default=40) TrainingMode : Training Mode: T or F Force : Force Duplicates: T or F SecureFormat : Encryption format: SecureMag | SecureMagV2 | MagneSafeV1 | MagneSafeV2 SecurityInfo : Key Serial Number generated by secure card reader Track1 : Encrypted Track1 data Track2 : Encrypted Track2 data -
ProcessLoyaltyCard
Process ePayment Loyalty Card Transaction. (For result codes, see ProcessCreditCard.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway TransType : Activate | Deactivate | Refund | Redeem | Inquire | Reload CardNum : Payment Card Number ExpDate : Payment Card Expiration Date in MMYY format MagData : Payment Card Track II Mag-Stripe Data Amount : Amount in DDDDD.CC format InvNum : Invoice Tracking Number PNRef : Reference Number Assigned by the payment gateway ExtData : Extended Data in XML. Valid input values are: Timeout : Timeout Value in Seconds (default=40) TrainingMode : Training Mode: T or F Force : Force Duplicates: T or F SecureFormat : Encryption format: SecureMag | SecureMagV2 | MagneSafeV1 | MagneSafeV2 SecurityInfo : Key Serial Number generated by secure card reader Track1 : Encrypted Track1 data Track2 : Encrypted Track2 data -
ProcessSignature
Process Signature Transaction. (For result codes, see ProcessCreditCard.)
Valid input values are:UserName
& Password:
:Assigned by the payment gateway SignatureType : One of these valid types: Signature1 : for Lipman Credit Signature2 : Lipman Check Signature3 : for AppForge Signature4 : for app other than AppForge Receipt1 : for TIFF file SignatureData : An array of coordinate in the following format: x1,y1^x2,y2^x3,y3^...xn,yn^~
Use 0,65535 as the x,y coordinate for any pen-up eventExtData : Extended Data in XML. Valid input values are: TrainingMode : Training Mode: T or F