DC Gateway Recurring Web Service


Web Services Main Menu

Add Recurring Check. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CustomerID – A merchant supplied unique identifier for the customer, CustomerName – The customer’s name, FirstName – The customer’s first name, LastName – The customer’s last name, Title – The customer’s title, Department – The customer’s department, Street1 – The customer’s street address 1, Street2 - The customer’s street address 2, Street3 - The customer’s street address 3, City – The customer’s city, StateID – The customer’s 2 charater State Code, Province – The customer’s province if outside USA, Zip – The customer’s zip code if in USA | Postal code if outside USA, CountryID – The customer’s 3 character country code, Email – The customer’s email address, DayPhone – The customer’s day phone, NightPhone – The customer’s night phone, Fax – The customer’s fax, Mobile – The customer’s mobile phone, ContractID – The merchant supplied unique identifier for the contract, ContractName – The contract’s name, BillAmt – Bill amount, TaxAmt – Tax amount, TotalAmt – BillAmt + TaxAmt, StartDate – The start date of the contract, EndDate – The end date of the contract, BillingPeriod – Day | Week | Month | Year, BillingInterval - Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year, MaxFailures - The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode, FailureInterval - Number of days the system will wait after each retry when the payment fails, EmailCustomer – True | False, EmailMerchant – True | Fale, EmailCustomerFailure – True | False, EmailMerchantFailure – True | False, CheckType – Personal | Corporate | Government, AccountType – Checking | Savings, CheckNum – Check Number, MICR – The scanned check MICR data, AccountNum – The account number, TransitNum – Transit Number, SS – Social Security number of the check holder, DOB – Date of birth of the check holder, BranchCity – The city of the bank where account is located, DL – Driver license of the check holder, StateCode – The 2 character State Code of the driver license of the check holder, NameOnCheck – The check holder’s name as it is on the check, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
CustomerID:
CustomerName:
FirstName:
LastName:
Title:
Department:
Street1:
Street2:
Street3:
City:
StateID:
Province:
PostalCode:
CountryID:
Email:
DayPhone:
NightPhone:
Fax:
Mobile:
ContractID:
ContractName:
BillAmt:
TaxAmt:
TotalAmt:
StartDate:
EndDate:
BillingPeriod:
BillingInterval:
MaxFailures:
FailureInterval:
EmailCustomer:
EmailMerchant:
EmailCustomerFailure:
EmailMerchantFailure:
CheckType:
AccountType:
CheckNum:
MICR:
AccountNum:
TransitNum:
SS:
DOB:
BranchCity:
DL:
StateCode:
NameOnCheck:
ExtData:

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

Add Recurring Credit Card. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CustomerID – A merchant supplied unique identifier for the customer, CustomerName – The customer’s name, FirstName – The customer’s first name, LastName – The customer’s last name, Title – The customer’s title, Department – The customer’s department, Street1 – The customer’s street address 1, Street2 - The customer’s street address 2, Street3 - The customer’s street address 3, City – The customer’s city, StateID – The customer’s 2 charater State Code, Province – The customer’s province if outside USA, Zip – The customer’s zip code if in USA | Postal code if outside USA, CountryID – The customer’s 3 character country code, Email – The customer’s email address, DayPhone – The customer’s day phone, NightPhone – The customer’s night phone, Fax – The customer’s fax, Mobile – The customer’s mobile phone, ContractID – The merchant supplied unique identifier for the contract, ContractName – The contract’s name, BillAmt – Bill amount, TaxAmt – Tax amount, TotalAmt – BillAmt + TaxAmt, StartDate – The start date of the contract, EndDate – The end date of the contract, BillingPeriod – Day | Week | Month | Year, BillingInterval - Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year, MaxFailures - The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode, FailureInterval - Number of days the system will wait after each retry when the payment fails, EmailCustomer – True | False, EmailMerchant – True | Fale, EmailCustomerFailure – True | False, EmailMerchantFailure – True | False, CcAccountNum – Credit Card account number, CcExpDate – Credit Card expiration date, CcStreet – Card holder’s billing address, CcZip – Card holder’s billing zip code, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
CustomerID:
CustomerName:
FirstName:
LastName:
Title:
Department:
Street1:
Street2:
Street3:
City:
StateID:
Province:
Zip:
CountryID:
Email:
DayPhone:
NightPhone:
Fax:
Mobile:
ContractID:
ContractName:
BillAmt:
TaxAmt:
TotalAmt:
StartDate:
EndDate:
BillingPeriod:
BillingInterval:
MaxFailures:
FailureInterval:
EmailCustomer:
EmailMerchant:
EmailCustomerFailure:
EmailMerchantFailure:
CcAccountNum:
CcExpDate:
CcNameOnCard:
CcStreet:
CcZip:
ExtData:

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

Manages stored check information. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType – Add | Update | Delete, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, CheckInfoKey – The numerical Check Info Key, CheckType – Personal | Corporate | Government, AccountType – Checking | Savings, CheckNum – Check Number, RawMICR – The scanned check MICR data, AccountNum – The account number, TransitNum – Transit Number, SS – Social Security number of the check holder, DOB – Date of birth of the check holder, BranchCity – The city of the bank where account is located, DL – Driver license of the check holder, StateCode – The 2 character State Code of the driver license of the check holder, NameOnCheck – The check holder’s name as it is on the check, Email – The customer’s email address, DayPhone – The customer’s day phone, Street1 – The customer’s street address 1, Street2 - The customer’s street address 2, Street3 - The customer’s street address 3, City – The customer’s city, StateID – The customer’s 2 charater State Code, Province – The customer’s province if outside USA, PostalCode – The customer’s zip code if in USA | Postal code if outside USA, CountryID – The customer’s 3 character country code, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
TransType:
Vendor:
CustomerKey:
CheckInfoKey:
CheckType:
AccountType:
CheckNum:
MICR:
AccountNum:
TransitNum:
RawMICR:
SS:
DOB:
BranchCity:
DL:
StateCode:
NameOnCheck:
Email:
DayPhone:
Street1:
Street2:
Street3:
City:
StateID:
Province:
PostalCode:
CountryID:
ExtData:

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

Manage recurring contract. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType – Add | Update | Delete, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, ContractKey – The numerical contract key, PaymentInfoKey – The numerical key for stored payment method, PaymentType – CC | CK, CustomerID – A merchant supplied unique identifier for the customer, CustomerName – The customer’s name, FirstName – The customer’s first name, LastName – The customer’s last name, Title – The customer’s title, Department – The customer’s department, Street1 – The customer’s street address 1, Street2 - The customer’s street address 2, Street3 - The customer’s street address 3, City – The customer’s city, StateID – The customer’s 2 charater State Code, Province – The customer’s province if outside USA, Zip – The customer’s zip code if in USA | Postal code if outside USA, CountryID – The customer’s 3 character country code, Email – The customer’s email address, DayPhone – The customer’s day phone, NightPhone – The customer’s night phone, Fax – The customer’s fax, Mobile – The customer’s mobile phone, ContractID – The merchant supplied unique identifier for the contract, ContractName – The contract’s name, BillAmt – Bill amount, TaxAmt – Tax amount, TotalAmt – BillAmt + TaxAmt, StartDate – The start date of the contract, EndDate – The end date of the contract, NextBillDt – The next bill date of the contract, BillingPeriod – Day | Week | Month | Year, BillingInterval - Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year, MaxFailures - The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode, FailureInterval - Number of days the system will wait after each retry when the payment fails, EmailCustomer – True | False, EmailMerchant – True | Fale, EmailCustomerFailure – True | False, EmailMerchantFailure – True | False, Status – Active | Inactive, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
TransType:
Vendor:
CustomerKey:
ContractKey:
PaymentInfoKey:
PaymentType:
CustomerID:
CustomerName:
FirstName:
LastName:
Title:
Department:
Street1:
Street2:
Street3:
City:
StateID:
Province:
Zip:
CountryID:
Email:
DayPhone:
NightPhone:
Fax:
Mobile:
ContractID:
ContractName:
BillAmt:
TaxAmt:
TotalAmt:
StartDate:
EndDate:
NextBillDt:
BillingPeriod:
BillingInterval:
MaxFailures:
FailureInterval:
EmailCustomer:
EmailMerchant:
EmailCustomerFailure:
EmailMerchantFailure:
Status:
ExtData:

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

Adds days to next bill date of contract. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, ContractKey – The numerical contract key, NumOfDays – The number of days to be added, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
CustomerKey:
ContractKey:
NumOfDays:
ExtData:

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

Manages stored card information. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType – Add | Update | Delete, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, CardInfoKey – The numerical Card Info Key, CcAccountNum – Credit Card account number, CcExpDate – Credit Card expiration date, CcNameOnCard – The card holder’s name as it is on the card, CcStreet – Card holder’s billing address, CcZip – Card holder’s billing zip code, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
TransType:
Vendor:
CustomerKey:
CardInfoKey:
CcAccountNum:
CcExpDate:
CcNameOnCard:
CcStreet:
CcZip:
ExtData:

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

Manage cusomers. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType – Add | Update | Delete, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, CustomerID – A merchant supplied unique identifier for the customer, CustomerName – The customer’s name, FirstName – The customer’s first name, LastName – The customer’s last name, Title – The customer’s title, Department – The customer’s department, Street1 – The customer’s street address 1, Street2 - The customer’s street address 2, Street3 - The customer’s street address 3, City – The customer’s city, StateID – The customer’s 2 charater State Code, Province – The customer’s province if outside USA, Zip – The customer’s zip code if in USA | Postal code if outside USA, CountryID – The customer’s 3 character country code, Email – The customer’s email address, DayPhone – The customer’s day phone, NightPhone – The customer’s night phone, Fax – The customer’s fax, Mobile – The customer’s mobile phone, Status – Active | Inactive, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
TransType:
Vendor:
CustomerKey:
CustomerID:
CustomerName:
FirstName:
LastName:
Title:
Department:
Street1:
Street2:
Street3:
City:
StateID:
Province:
Zip:
CountryID:
Email:
DayPhone:
NightPhone:
Fax:
Mobile:
Status:
ExtData:

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

Process ePayment Recurring Check Transaction. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CheckInfoKey – The numerical Check Info Key, Amount - Amount in DDDDD.CC format, InvNum - Invoice Tracking Number, ExtData - Extended Data in XML, Valid Values are: Timeout - Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
CheckInfoKey:
Amount:
InvNum:
ExtData:

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

Process ePayment Recurring Credit Card Transaction. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CcInfoKey – The numerical Credit Card Info Key, Amount - Amount in DDDDD.CC format, InvNum - Invoice Tracking Number, ExtData - Extended Data in XML, Valid Values are: Timeout - Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
CcInfoKey:
Amount:
InvNum:
ExtData:

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

Update all contracts. Valid input values are: UserName & Password - Assigned by the payment gateway, Vendor – The numerical Vendor/Merchant key, CustomerKey – The numerical Customer Key, ContractKey – The numerical contract key, NumOfDays – The number of days to be added, ExtData – Extended Data in XML, Valid Values are: Timeout – Timeout Value in Seconds (default=40), TrainingMode - Training Mode T or F

Parameter Value
Username:
Password:
Vendor:
MaxFailures:
FailureInterval:
ExtData:

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