1.CheckoutPage.aspx
<%@ Page Language="C#" %>
2.ProcessPage.aspx
<%@ Page Language="C#" %>
3.ProcessReturnPage.aspx
<%@ Page Language="C#" EnableViewState="false" EnableViewStateMac="false"%>
<%@ Page Language="C#" %>
<%@ Page Language="C#" %>
<%@ Page Language="C#" EnableViewState="false" EnableViewStateMac="false"%>
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 | 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. | | 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 ‘ | | 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 | | 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. | | 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 ‘ | | 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 | 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. | | 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 ‘ | | 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 method="POST" action="http://localhost/PaymentMain.aspx ">
<input type="hidden" name="ClientSessionID" >
<input type="hidden" name="ProcessType" >
<input type="hidden" name="TransType" >
<input type="hidden" name="UserName" >
<input type="hidden" name="Amount" >
<input type="hidden" name="TransNum" >
<input type="hidden" name="ReturnURL" >
<input type="hidden" name="PageTitle" >
<input type="hidden" name="HasHeader" >
<input type="hidden" name="NameOnCard" >
<input type="hidden" name="Address" >
<input type="hidden" name="City" >
<input type="hidden" name="State" >
<input type="hidden" name="Zip" >
<input type="hidden" name="TxnsTitle" >
<input type="hidden" name="TxnsNumCaption" >
<input type="hidden" name="TxnsAmountCaption" >
<input type="hidden" name="CONFeeCaption" >
<input type="hidden" name="TotalAmountCaption" >
<input type="hidden" name="FinishButtonCaption" >
<input type="hidden" name="TotalAttempts" >
<input type="hidden" name="UsedAttempts" >
<input type="hidden" name="PromptCancel" >
<input type="hidden" name="ShowTransNo" >
<input type="hidden" name="CanSaveCard" >
<input type="hidden" name="CustonerID" >
<input type="hidden" name=" CustonerName" >
<input type="hidden" name=" InvocieNo" >
<input type="hidden" name=" PONum" >
<input type="hidden" name=" IsQuickCheckout" >
<input type="hidden" name="CustomerFirstName" >
<input type="hidden" name="CustomerLastName" >
<input type="hidden" name="CustomerStreet2" >
<input type="hidden" name="Customer Street3" >
<input type="hidden" name="CustomerEmail" >
<input type="hidden" name="CustomerDayPhone" >
<input type="hidden" name="CustomerNightPhone" >
<input type="hidden" name=" CustomerMobile" >
<input type="hidden" name=" CustomerFax" >
<input type="hidden" name=" CustomerProvince" >
<input type="hidden" name=" CustomerCountryID" >
<input type="hidden" name=" TaxAmount" >
<input type="submit" value="submit" name=" submit ">
</form>
(b) Process Check
<form method="POST" action="http://localhost/PaymentMain.aspx ">
<input type="hidden" name="ClientSessionID " >
<input type="hidden" name="ProcessType " >
<input type="hidden" name="TransType" >
<input type="hidden" name="UserName " >
<input type="hidden" name="Amount" >
<input type="hidden" name="TransNum" >
<input type="hidden" name="ReturnURL" >
<input type="hidden" name="PageTitle" >
<input type="hidden" name="HasHeader" >
<input type="hidden" name="NameOnCheck " >
<input type="hidden" name="Address" >
<input type="hidden" name="City" >
<input type="hidden" name="State" >
<input type="hidden" name="Zip" >
<input type="hidden" name="ContactPhone" >
<input type="hidden" name="TxnsTitle" >
<input type="hidden" name="TxnsNumCaption" >
<input type="hidden" name="TxnsAmountCaption" >
<input type="hidden" name="CONFeeCaption" >
<input type="hidden" name="TotalAmountCaption" >
<input type="hidden" name="FinishButtonCaption" >
<input type="hidden" name="TotalAttempts" >
<input type="hidden" name="UsedAttempts" >
<input type="hidden" name="PromptCancel" >
<input type="hidden" name="ShowTransNo" >
<input type="hidden" name=" InvocieNo" >
<input type="hidden" name=" PONum" >
<input type="hidden" name=" IsQuickCheckout" >
<input type="hidden" name="CustomerFirstName" >
<input type="hidden" name="CustomerLastName" >
<input type="hidden" name="CustomerStreet2" >
<input type="hidden" name="Customer Street3" >
<input type="hidden" name="CustomerEmail" >
<input type="hidden" name="CustomerDayPhone" >
<input type="hidden" name="CustomerNightPhone" >
<input type="hidden" name=" CustomerMobile" >
<input type="hidden" name=" CustomerFax" >
<input type="hidden" name=" CustomerProvince" >
<input type="hidden" name=" CustomerCountryID" >
<input type="submit" value="submit" name=" submit ">
</form>
(c) Process GSB Card
<form method="POST" action="http://localhost/PaymentMain.aspx ">
<input type="hidden" name="ClientSessionID" >
<input type="hidden" name="ProcessType" >
<input type="hidden" name="TransType" >
<input type="hidden" name="UserName" >
<input type="hidden" name="Amount" >
<input type="hidden" name="TransNum" >
<input type="hidden" name="ReturnURL" >
<input type="hidden" name="PageTitle" >
<input type="hidden" name="HasHeader" >
<input type="hidden" name="FirstName" >
<input type="hidden" name="LastName" >
<input type="hidden" name="Address" >
<input type="hidden" name="City" >
<input type="hidden" name="State" >
<input type="hidden" name="Zip" >
<input type="hidden" name="TxnsTitle" >
<input type="hidden" name="TxnsNumCaption" >
<input type="hidden" name="TxnsAmountCaption" >
<input type="hidden" name="CONFeeCaption" >
<input type="hidden" name="TotalAmountCaption" >
<input type="hidden" name="FinishButtonCaption" >
<input type="hidden" name="TotalAttempts" >
<input type="hidden" name="UsedAttempts" >
<input type="hidden" name="PromptCancel" >
<input type="hidden" name="ShowTransNo" >
<input type="hidden" name="CanSaveCard" >
<input type="hidden" name="CustonerID" >
<input type="hidden" name=" CustonerName" >
<input type="hidden" name=" InvocieNo" >
<input type="hidden" name=" PONum" >
<input type="hidden" name=" IsQuickCheckout" >
<input type="hidden" name="CustomerFirstName" >
<input type="hidden" name="CustomerLastName" >
<input type="hidden" name="CustomerStreet2" >
<input type="hidden" name="Customer Street3" >
<input type="hidden" name="CustomerEmail" >
<input type="hidden" name="CustomerDayPhone" >
<input type="hidden" name="CustomerNightPhone" >
<input type="hidden" name=" CustomerMobile" >
<input type="hidden" name=" CustomerFax" >
<input type="hidden" name=" CustomerProvince" >
<input type="hidden" name=" CustomerCountryID" >
<input type="hidden" name=" TaxAmount" >
<input type="submit" value="submit" name=" submit ">
</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();