DC Gateway Transaction Web Services


Web Services Main Menu

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, Register_Num - For TransType Initialize contains the register number to be initialized with host (currently only supported for TSYS SGMF).

Parameter Value
UserName:
Password:
TransType:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process Cash Transaction. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType - Sale | Return | RepeatSale| Adjustment, Amount - Amount in DDDDD.CC format, InvNum - Invoice Tracking Number, PNRef - Reference Number Assigned by the payment gateway, RegisterNum – Register Number ExtData - Extended Data in XML, Valid Values are: 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, PONum - Purhcase Order Number

Parameter Value
UserName:
Password:
TransType:
Amount:
InvNum:
PNRef:
RegisterNum:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

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, Amount - Amount in DDDDD.CC format, MICR - MICR, NameOnCheck - NameOnCheck, DL - Drivers License, SS - Social Security, StateCode - State Code of the Driver License, CheckType - CheckType (Personal | Corporate | Government), 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

Parameter Value
UserName:
Password:
TransType:
CheckNum:
TransitNum:
AccountNum:
Amount:
MICR:
NameOnCheck:
DL:
SS:
DOB:
StateCode:
CheckType:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

ePayment Credit Card Transaction. 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 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

Parameter Value
UserName:
Password:
TransType:
CardNum:
ExpDate:
MagData:
NameOnCard:
Amount:
InvNum:
PNRef:
Zip:
Street:
CVNum:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process ePayment Debit Card Transactions. 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 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

Parameter Value
UserName:
Password:
TransType:
CardNum:
ExpDate:
MagData:
NameOnCard:
Amount:
InvNum:
PNRef:
Pin:
RegisterNum:
SureChargeAmt:
CashBackAmt:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process ePayment EBT Card Transactions. 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, Pin - Pin 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 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

Parameter Value
UserName:
Password:
TransType:
CardNum:
ExpDate:
MagData:
NameOnCard:
Amount:
InvNum:
PNRef:
Pin:
RegisterNum:
SureChargeAmt:
CashBackAmt:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process ePayment Gift Card Transaction. 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, NameOnCard - Cardholders Name, Amount - Amount in DDDDD.CC format, InvNum - Invoice Tracking Number, PNRef - Reference Number Assigned by the payment gateway, ExtData - Extended Data in XML, Valid Values are: Timeout - Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F, Force - Force Duplicates T or F

Parameter Value
UserName:
Password:
TransType:
CardNum:
ExpDate:
MagData:
Amount:
InvNum:
PNRef:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process ePayment Loyalty Card Transaction. 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, NameOnCard - Cardholders Name, Amount - Amount in decimal format, InvNum - Invoice Tracking Number, PNRef - Reference Number Assigned by the payment gateway, ExtData - Extended Data in XML, Valid Values are: Timeout - Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F, Force - Force Duplicates T or F

Parameter Value
UserName:
Password:
TransType:
CardNum:
ExpDate:
MagData:
Amount:
InvNum:
PNRef:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST

Process Signature Transaction. Valid input values are: UserName & Password - Assigned by the payment gatewaySignatureType - Signature1 for Lipman credit, Signature2 for Lipman Check, Signature3 for AppForge, Signature4 for app other than AppForge, HYPERCOM_LEGACY for Hypercom legacy signature format, HYPERCOM_ENHANCED for Hypercom enhanced signature format, Receipt1 for TIFF fileSignatureData - For Hypercom Legacy and Enhanced Formats: Base64 encoded signature image data. For all other signature types: an array of coordinates in the following format: x1,y1^x2,y2^x3,y3^...xn,yn^~Use 0,65535 as the x,y coordinate for any pen-up event.ExtData - Extended Data in XML, Valid Values are: TrainingMode - Training Mode T or F

Parameter Value
UserName:
Password:
SignatureType:
SignatureData:
PNRef:
Result:
AuthCode:
ExtData:

Message Samples
  • SOAP 1.1
  • SOAP 1.2
  • HTTP GET
  • HTTP POST