Search TipsParameters for Populating Fields or Requesting Data
By adding parameters to your Base URL, you can do the following:
-
Pass information from your website to your payment page.
-
Pre-populate fields in the payment form.
-
Display links or text after a transaction completes.
-
Make a request to capture specific data during payment and then pass it back to you after a completed transaction.
The table lists parameters for populating fields on your payment page or for requesting data after a completed transaction.
| Parameter | Description |
|---|---|
| x-billname |
Sends the consumer's first and last name. Get Request (append to base URL):
Post Request:
|
| x-billemail |
Sends the consumer's email address. Get Request (append to base URL):
Post Request:
|
| x-billaddr |
Sends the consumer's street address. Get Request (append to base URL):
Post Request:
|
| x-billcity |
Sends the consumer's city. Get Request (append to base URL): Post Request:
|
| x-billstate |
Sends the consumer's State/Province/Territory (Ask your Segpay Account Rep for a list of valid entries). Get Request (append to base URL):
Post Request:
|
| x-billzip |
Sends the consumer's zip/postal code. Get Request (append to base URL):
Post Request:
|
| x-billcntry |
Sends the consumer's country (Ask your Segpay Account Rep for a list of valid entries). Get Request (append to base URL):
Post Request:
|
| merchantpartnerid |
Used only for postbacks - does not display on the payment page. Merchantpartnerid appears in transaction reports and helps both you and Segpay's Risk Management team manage the transactions coming from your affiliate program. An affiliate is a partner who links to your payment page to send you referrals. Get Request (append to base URL):
Post Request:
|
| x-auth-link |
Specifies the link to display for the consumer after an authorized transaction. Get Request (append to base URL):
Post Request:
|
| x-auth-text |
Displays customized text for the link that displays after an authorized transaction. Combine with x-auth-link. Get Request (append to base URL):
Post Request:
|
| x-decl-link |
Displays a specified link to the consumer after a declined transaction. Get Request (append to base URL):
Post Request: <input type="hidden" name="x-decl-link" value="http://www.yoursite.com/LinkToOtherPaymentOptions"> |
| x-decl-text |
Displays customized text for the link the consumer sees after a declined transaction. Combine with the x-decl-link. Get Request (append to base URL):
Post Request:
|
| username |
Sends the consumer's username. Get Request (append to base URL):
Post Request:
|
| password |
Sends the consumer's password. Get Request (append to base URL):
Post Request:
|
| CrossSaleOff |
Does not display the cross-sell options on your payment page that you assigned to your payment package. Get Request (append to base URL):
|
User-Defined Parameters
You can pass your own user-defined data to Segpay using parameters such as memberIDor sessionID. A user-defined parameter is data that's dynamically generated by your system.
-
There's no limit to the number of user-defined parameters you can create and send to Segpay.
-
Values are limited to 32 characters and cannot begin with a number.
-
User-defined parameters are stored in a field called USERDATA and included in the Transaction Detail Report in the Merchant Portal and in the Segpay Reporting Services (SRS) transaction reports.
Examples of User-Defined Parameters: memberID, sessionID
Get Request (append to base URL):
https://secure2.segpay.com/billing/poset.cgi?x-eticketid=######:####&x-billemail=anyone@abc.com&x-billzip=12345&username=anyuser&password=anypassword&memberid=anymemberID&x-auth-link=http://www.yoursite.com/members&x-auth-text=CLICK+HERE+TO+SIGNIN+TO+THE+MEMBERS+AREA!&x-decl-link= http://www.yoursite.com/LinkToOtherPaymentOptions&x-decl-text=CLICK+HERE+TO+TRY+ADDITIONAL+PAYMENT+OPTIONS
Post Request:
<form method="post" action="https://secure2.segpay.com/billing/poset.cgi?x-eticketid=######:####">
<input type="hidden" name="x-billemail" value="anyone@abc.com ">
<input type="hidden" name="x-billzip" value="12345">
<input type="hidden" name="username" value="anyuser">
<input type="hidden" name="password" value="anypassword">
<input type="hidden" name="memberID" value="anymemberID">
<input type="hidden" name="x-auth-link" value=" http://www.yoursite.com/members">
<input type="hidden" name="x-auth-text" value="CLICK HERE TO SIGNIN TO THE MEMBERS AREA!">
<input type="hidden" name="x-decl-link" value="http://www.yoursite.com/ LinkToOtherPaymentOptions">
<input type="hidden" name="x-decl-text" value="CLICK HERE TO TRY ADDITIONAL PAYMENT OPTIONS">
<input type="submit" name="Submit" value="Join Now"></form>
REF Parameters
You can define your own REF data.
-
Up to 10 REF values: REF1 - REF10.
-
REF values are each stored in their own fields and reported separately from user-defined values.
-
REF values are encrypted for added security when stored in our database.
Example of REF Parameter: &REF1=
Get Request (append to base URL):
https://secure2.segpay.com/billing/poset.cgi?x-eticketid=######:####&REF1=XXXXPost Request:
<form method="post" action="https://secure2.segpay.com/billing/poset.cgi?x-eticketid=######:####">
<input type="hidden" name="REF1" value="XXXX ">
</form>
If you selected “Collect Username and Password” (or Password only) when creating your price points, these fields will display on the payment form and can be pre-populated using the parameters above. Otherwise login data can be passed to Segpay in the background. This is recommended if you assign logins to your consumers or if you let your consumers pick their own username or password on your site.