HeartLand Payment Gateway: Variable Used During Integration of HeartLand Payment Gateway

1. Process Credit Card

(1)When the customer website redirect to the web portal, it should send these information to the web portal.

Field Name	Description	Value	Optional
ClientSessionID	The session’s ID of customer website, it will be returned when the process is finished.		No
ProcessType	The process type.	CreditCard	No
TransType	Transaction type	Auth Sale	No
UserName	The user name assigned by the payment gateway.		No
Amount	The transaction amount. The amount must in DDDDD.CC format.		No
TransNum	The transaction number.		No
ReturnURL	The URL which is redirected when the process is finished. The URL must begin with http:// or https://		No
CanSaveCard	The user can process payment by using the existing Card/Check or not. Default value is “No”.	Yes No	Yes
CustomerID	The merchant’s client customer ID. This is a unique ID for each customer. It is used to verify the customer’s information and filter the payment profile of the customer. Please format the value of this field as “Your website alias_The customer unique ID in your website”. For example: If the alias of your website is “TW”, the customer unique ID in your website is “12345”, format the value of this field as: “TW_12345” This field only can be used when the value of the field “CanSaveCard” is “Yes”.	Format the value as the blue part.	Required when the value of the field “CanSaveCard” is “Yes”
CustomerName	The merchant’s client customer name. This field only can be used when the value of the field “CanSaveCard” is “Yes”.		Required when the value of the field “CanSaveCard” is “Yes”
PageTitle	The page title of process page.		Yes
HasHeader	Does the process page have header or not? If the process page is included in the page of customer website, this value will be “false”.	true false	No
NameOnCard	The name on the credit card.		Yes
Address	The card holder’s address.		Yes
City	The card holder’s city.		Yes
State	The card holder’s 2 character state code. Such as ‘AL ‘.		Yes
Zip	The card holder’s zip. The zip code must be 5-digit such as ‘12345’.		Yes
TxnsTitle	The tile of the transaction function part. If this value is blank, it will use the default description		Yes
TxnsNumCaption	The caption of the transaction number. You can change the caption of the transaction number with your personal caption. If this value is blank, it will use the default description		Yes
TxnsAmountCaption	The caption of the transaction amount. You can change the caption of the transaction amount with your personal caption. If this value is blank, it will use the default description		Yes
CONFeeCaption	The caption of the convenience fee. You can change the caption of the convenience fee with your personal caption. If this value is blank, it will use the default description		Yes
TotalAmountCaption	The caption of the total amount. You can change the caption of the total amount with your personal caption. If this value is blank, it will use the default description		Yes
FinishButtonCaption	The caption of the “Finish” button. You can change the caption of the “Finish” button with your personal caption. If this value is blank, it will use the default description		Yes
TotalAttempts	The total number of attempts allowed for processing the credit card/ checking account payment transaction. Must be an integer.		Yes
UsedAttempts	The number of attempts used for processing the credit card/ checking account payment transaction. Must be integer.		Yes
PromptCancel	Setting to display a confirmation prompt when the user wants to cancel the transaction.	Yes No	Yes
ShowTransNo	Setting to display the transaction number on the page.	Yes No	Yes
InvocieNo	The invocie number. The value of this field will be sent to HPS merchant center. But if the value of this field is blank, WebConnect will use the value of the field “TransNum” as the default value.		Yes
IsQuickCheckout	Whether this process is sent form the Quick Checkout Portal.	Yes No	Yes
CustomerFirstName	The merchant’s client customer’s first name.		Yes
CustomerLastName	The merchant’s client customer’s last name.		Yes
CustomerStreet2	The merchant’s client customer’s street 2.		Yes
CustomerStreet3	The merchant’s client customer’s street 3.		Yes
CustomerEmail	The merchant’s client customer’s email address.		Yes
CustomerDayPhone	The merchant’s client customer’s daytime phone.		Yes
CustomerNightPhone	The merchant’s client customer’s night phone.		Yes
CustomerMobile	The merchant’s client customer’s mobile.		Yes
CustomerFax	The merchant’s client customer’s fax.		Yes
CustomerProvince	The merchant’s client customer’s province.		Yes
CustomerCountryID	The merchant’s client customer’s country ID.		Yes
PONum	For purchase order number. (Note* This is to be used for Level II information except Global Payments.)		Yes
TaxAmount	For tax amount in DDDD.CC format. (Note* This is to be used for Level II information except Global Payments.)		Yes

(2)When the web portal finished processing credit card, it will return this information to the customer website.

Field Name	Description	Value
ClientSessionID	The session’s ID of customer website.
TransNum	The transaction number.
ResultNum	The result number for processing credit card.	0=Successful 1=Canceled 2=Back 3=MaxAttempts 4=TimeOut (The session will be time out after 15 minutes)
AuthorizationCode	The authorization code assigned by the payment gateway.
ReferenceNumber	The reference number assigned by the payment gateway.
CardNumber	The last 4 digit of credit card number.
CardType	The card type of the credit card used for the transaction.
UsedAttempts	The number of attempts used for processing the credit card payment transaction. Must be an integer.

2. Process Check

(1) When the customer website redirect to the web portal, it should send these information to the web portal.

Field Name	Description	Value	Optional
ClientSessionID	The session’s ID of customer website, it will be returned when the process is finished.		No
ProcessType	The process type.	Check	No
TransType	Transaction type	Sale	No
UserName	The user name assigned by the payment gateway.		No
Amount	The transaction amount. The amount must in DDDDD.CC format.		No
TransNum	The transaction number.		No
ReturnURL	The URL which is redirected when the process is finished. The URL must begin with http:// or https://		No
CanSaveCard	The user can process payment by using the existing Card/Check or not. Default value is “No”.	Yes No	No
CustomerID	The merchant’s client customer ID. This is a unique ID for each customer. It is used to verify the customer’s information and filter the payment profile of the customer. Please format the value of this field as “Your website alias_The customer unique ID in your website”. For example: If the alias of your website is “TW”, the customer unique ID in your website is “12345”, format the value of this field as: “TW_12345” This field only can be used when the value of the field “CanSaveCard” is “Yes”.	Format the value as the blue part.	Required when the value of the field “CanSaveCard” is “Yes”
CustomerName	The merchant’s client customer name. This field only can be used when the value of the field “CanSaveCard” is “Yes”.		Required when the value of the field “CanSaveCard” is “Yes”
PageTitle	The page title of process page.		Yes
HasHeader	If the process page has header or not. If the process page is included in the page of customer website, this value will be “false”.	true false	No
NameOnCheck	The name on the check.		Yes
Address	The check holder’s address.		Yes
City	The check holder’s city.		Yes
State	The check holder’s 2 character state code. Such as ‘AL ‘.		Yes
Zip	The check holder’s zip. The zip code must be 5-digit such as ‘12345.’		Yes
ContactPhone	The card holder’s contact phone.		Yes
TxnsTitle	The tile of the transaction function part. If this value is blank, it will use the default description		Yes
TxnsNumCaption	The caption of the transaction number. You can change the caption of the transaction number with your personal caption. If this value is blank, it will use the default description		Yes
TxnsAmountCaption	The caption of the transaction amount. You can change the caption of the transaction amount with your personal caption. If this value is blank, it will use the default description		Yes
CONFeeCaption	The caption of the convenience fee. You can change the caption of the convenience fee with your personal caption. If this value is blank, it will use the default description		Yes
TotalAmountCaption	The caption of the total amount. You can change the caption of the total amount with your personal caption. If this value is blank, it will use the default description		Yes
FinishButtonCaption	The caption of the “Finish” button. You can change the caption of the “Finish” button with your personal caption. If this value is blank, it will use the default description		Yes
TotalAttempts	The total number of attempts allowed for processing the credit card/ checking account payment transaction. Must be an integer.		Yes
UsedAttempts	The number of attempts used for processing the credit card/ checking account payment transaction. Must be integer.		Yes
PromptCancel	Setting to display a confirmation prompt when the user wants to cancel the transaction.	Yes No	Yes
ShowTransNo	Setting to display the transaction number on the page.	Yes No	Yes
InvocieNo	The invocie number. The value of this field will be sent to HPS merchant center. But if the value of this field is blank, WebConnect will use the value of the field “TransNum” as the default value.		Yes
PONum	The purchase order number.		Yes
IsQuickCheckout	Whether this process is sent form the Quick Checkout Portal.	Yes No	Yes
CustomerFirstName	The merchant’s client customer’s first name.		Yes
CustomerLastName	The merchant’s client customer’s last name.		Yes
CustomerStreet2	The merchant’s client customer’s street 2.		Yes
CustomerStreet3	The merchant’s client customer’s street 3.		Yes
CustomerEmail	The merchant’s client customer’s email address.		Yes
CustomerDayPhone	The merchant’s client customer’s daytime phone.		Yes
CustomerNightPhone	The merchant’s client customer’s night phone.		Yes
CustomerMobile	The merchant’s client customer’s mobile.		Yes
CustomerFax	The merchant’s client customer’s fax.		Yes
CustomerProvince	The merchant’s client customer’s province.		Yes
CustomerCountryID	The merchant’s client customer’s country ID.		Yes

(2)When the web portal finished processing check, it will return this information to the customer website.

Field Name	Description	Value
ClientSessionID	The session’s ID of customer website.
TransNum	The transaction number.
ResultNum	The result number for processing check.	0=Successful 1=Canceled 2=Back 3=MaxAttempts 4=TimeOut (The session will be time out after 15 minutes)
AuthorizationCode	The authorization code assigned by the payment gateway.
ReferenceNumber	The reference number assigned by the payment gateway.
AccountNumber	The last 4 digit of account number.
CardType	The card type of the credit card which the user used for the transaction.
UsedAttempts	The number of attempts used for processing the checking account payment transaction. Must be an integer.

3. Process GSB Card

(1)When the customer website redirect to the web portal, it should send these information to the web portal.

Field Name	Description	Value	Optional
ClientSessionID	The session’s ID of customer website, it will be returned when the process is finished.		No
ProcessType	The process type.	GSBCard	No
TransType	Transaction type	Auth Sale	No
UserName	The user name assigned by the payment gateway.		No
Amount	The transaction amount. The amount must in DDDDD.CC format.		No
TransNum	The transaction number.		No
ReturnURL	The URL which is redirected when the process is finished. The URL must begin with http:// or https://		No
PageTitle	The page title of process page.		Yes
HasHeader	Does the process page have header or not? If the process page is included in the page of customer website, this value will be “false”.	true false	No
FirstName	The card holder’s first name.		Yes
LastName	The card holder’s last name.
Address	The card holder’s address.		Yes
City	The card holder’s city.		Yes
State	The card holder’s 2 character state code. Such as ‘AL ‘.		Yes
Zip	The card holder’s zip. The zip code must be 5-digit such as ‘12345’.		Yes
TxnsTitle	The tile of the transaction function part. If this value is blank, it will use the default description		Yes
TxnsNumCaption	The caption of the transaction number. You can change the caption of the transaction number with your personal caption. If this value is blank, it will use the default description		Yes
TxnsAmountCaption	The caption of the transaction amount. You can change the caption of the transaction amount with your personal caption. If this value is blank, it will use the default description		Yes
CONFeeCaption	The caption of the convenience fee. You can change the caption of the convenience fee with your personal caption. If this value is blank, it will use the default description		Yes
TotalAmountCaption	The caption of the total amount. You can change the caption of the total amount with your personal caption. If this value is blank, it will use the default description		Yes
FinishButtonCaption	The caption of the “Finish” button. You can change the caption of the “Finish” button with your personal caption. If this value is blank, it will use the default description		Yes
TotalAttempts	The total number of attempts allowed for processing the credit card/ checking account payment transaction. Must be an integer.		Yes
UsedAttempts	The number of attempts used for processing the credit card/ checking account payment transaction. Must be integer.		Yes
PromptCancel	Setting to display a confirmation prompt when the user wants to cancel the transaction.	Yes No	Yes
ShowTransNo	Setting to display the transaction number on the page.	Yes No	Yes
InvocieNo	The invocie number. The value of this field will be sent to HPS merchant center. But if the value of this field is blank, WebConnect will use the value of the field “TransNum” as the default value.		Yes
IsQuickCheckout	Whether this process is sent form the Quick Checkout Portal.	Yes No	Yes
CustomerFirstName	The merchant’s client customer’s first name.		Yes
CustomerLastName	The merchant’s client customer’s last name.		Yes
CustomerStreet2	The merchant’s client customer’s street 2.		Yes
CustomerStreet3	The merchant’s client customer’s street 3.		Yes
CustomerEmail	The merchant’s client customer’s email address.		Yes
CustomerDayPhone	The merchant’s client customer’s daytime phone.		Yes
CustomerNightPhone	The merchant’s client customer’s night phone.		Yes
CustomerMobile	The merchant’s client customer’s mobile.		Yes
CustomerFax	The merchant’s client customer’s fax.		Yes
CustomerProvince	The merchant’s client customer’s province.		Yes
CustomerCountryID	The merchant’s client customer’s country ID.		Yes
PONum	For purchase order number. (Note* This is to be used for Level II information except Global Payments.)		Yes
TaxAmount	For tax amount in DDDD.CC format. (Note* This is to be used for Level II information except Global Payments.)		Yes

(2)When the web portal finished processing credit card, it will return this information to the customer website.

Field Name	Description	Value
ClientSessionID	The session’s ID of customer website.
TransNum	The transaction number.
ResultNum	The result number for processing credit card.	0=Successful 1=Canceled 2=Back 3=MaxAttempts 4=TimeOut (The session will be time out after 15 minutes)
AuthorizationCode	The authorization code assigned by the payment gateway.
ReferenceNumber	The reference number assigned by the payment gateway.
CardNumber	The last 4 digit of credit card number.
CardType	The card type of the credit card used for the transaction.
UsedAttempts	The number of attempts used for processing the credit card payment transaction. Must be an integer.

4. How the customer website send information to the web portal.

(1) When the customer website redirect to the web portal, please submit the information in a form to redirect to the web portal. Do not send the information in the URL visibly for the security reason. You can write the code like this:

(a) Process Credit Card

</form>

(b) Process Check

</form>

(c) Process GSB Card

</form>

The text “localhost” in the URL should be replaced with the actual host name or static IP address of the web portal server.

(2) When the web portal finished the transaction and redirect to the return URL of customer website, you can get the result information from the request. You can write code like this (The example code is ASP.net server site code):

String strClientSessionID = Request.Params["ClientSessionID"].ToString();

String strTransNum = Request.Params["TransNum"].ToString();

String strResultNum = Request.Params["ResultNum"].ToString();

String strAuthorizationCode = Request.Params["AuthorizationCode"].ToString();

String strReferenceNumber = Request.Params["ReferenceNumber"].ToString();

String strUsedAttempts = Request.Params["UsedAttempts"].ToString();

Hope this post will help you,
if yes please put comment below of this page,
Rajesh Singh,
Asp.Net Developer
Indianic Infotech Ltd (India)
rajesh@indianic.com

My Blog : Click Here

2 comments:

Anna SchaferFebruary 2, 2022 at 12:17 AM
Love what you're doing here guys, keep it up!.. White Label Payment Service Provider
Blog Comment BacklinksFebruary 8, 2022 at 12:49 AM
I admire what you have done here. I like the part where you say you are doing this to give back but I would assume by all the comments that this is working for you as well. North American Bancard Agent Program

HeartLand Payment Gateway

Wednesday, December 16, 2009

Variable Used During Integration of HeartLand Payment Gateway

2 comments:

Live Traffic