Postback Parameters
A parameter is a variable element of a URL used to transmit specific information. In the case of Segpay postbacks, parameters send details about transactions or user actions. Each parameter consists of a key (the name of the parameter) and a value (the information it carries).
The table on this page provides a comprehensive list of all the postback parameters you can add to postback URLs, along with the types of postbacks where each parameter is applicable.
-
You can customize the parameters you receive so that you only receive relevant information.
-
You can add specific parameters to the postback URL in any order.
-
If you don't add any parameters, all available parameters for that particular postback will be sent to you.
Parameter | Description |
---|---|
<Action> |
The action that generated this postback. Default values are:
Available for these Postback Types: |
<stage> |
The type of transaction that triggered the event. Supported values:
Available for these Postback Types: |
<approved> |
Available for these Postback Types: |
<trantype> |
Transaction Type:
Available for these Postback Types: |
<purchaseid> |
PurchaseID of transaction. Available for these Postback Types: |
<tranid> |
TransactionID of transaction. Available for these Postback Types: |
<price> |
Transaction amount. For currency type, see <currencycode> Available for these Postback Types: |
<currencycode> |
The currency used for the transaction:
Available for these Postback Types: |
<paymentaccountid> |
Secure ID string used to uniquely identify the credit card used in a transaction. Available for these Postback Types: |
<ipaddress> |
Consumer IP address. Available for these Postback Types: |
<relatedtranid> |
Transaction ID of the original sale. Only available for refund, void, chargeback and revoke transactions. Available for these Postback Types: |
<eticketid> |
PackageID:BillConfigID (Signup and Stand-In only). Available for these Postback Types: |
<ival> |
Initial transaction amount authorized for the sale. Available for these Postback Types: |
<iint> |
Length, in days, of the Initial billing period (trial). Available for these Postback Types: |
<rval> |
Recurring billing amount. 0 if no recurring amount. Available for these Postback Types: |
<rint> |
Length, in days, of the recurring billing period. Available for these Postback Types: |
<desc> |
Bill configuration description. Available for these Postback Types: |
<extra username> |
Username collected on the pay page. Available for these Postback Types: |
<extra password> |
Password collected on the pay page. Available for these Postback Types: |
<billname> |
Consumer’s first and last name. Available for these Postback Types: |
<billnamefirst> |
Consumer’s first name. Available for these Postback Types: |
<billnamelast> |
Consumer’s last name. Available for these Postback Types: |
<billemail> |
Consumer’s e-mail address. Available for these Postback Types: |
<billphone> |
Consumer’s phone number. Collected on the pay page or passed to Segpay from you. Only collected on check transactions. Available for these Postback Types: |
<billaddr> |
Consumer’s billing street address. Collected on the pay page or passed to Segpay from you. Available for these Postback Types: |
<billcity> |
Consumer’s billing city. Collected on the pay page or passed to Segpay from you. Available for these Postback Types: |
<billstate> |
Consumer’s billing state. Collected on the pay page or passed to Segpay from you. Available for these Postback Types: |
<billzip> |
Consumer’s billing zip code. Collected on the pay page or passed to Segpay from you. Available for these Postback Types: |
<billcntry> |
Consumer’s billing country, represented by a two-character ISO code. Collected on the pay page or passed to Segpay from you. Available for these Postback Types: |
<extra merchantpartnerid> |
The Affiliate ID passed to Segpay from you when the transaction executes. Use a unique value for the affiliate who referred the payment event to you. Providing this ID helps Segpay detect and prevent potential fraudulent activities, such as excessive trial sign-ups or unauthorized card use, which may be associated with certain affiliates. Additionally, this enables you to track and manage your affiliate sales through Segpay effectively. Available for these Postback Types: |
<transguid> |
The transaction Global Unique Identifier (GUID) assigned to the transaction by Segpay. Used for instant conversions. NOTE: This parameter is programmatically added to a post for all instant conversion transactions. Available for these Postback Types: |
<standin> |
-1 = Stand-In not supported. 0 = No stand-in occurred. 1 = Stand-in occurred. Available for these Postback Types: |
<xsellnum> |
0 = Main transaction. 1 = First cross sell. 2 = Second cross sell. Available for these Postback Types: |
<transtime> |
Date and Time (in GMT) the transaction occurred. Sent URL-encoded. Example: 7%2f28%2f2008+3%3a38%3a43+PM+(GMT+STANDARD+TIME) Example URL Decoded: 7/28/2008 3:38:43 PM (GMT STANDARD TIME) Available for these Postback Types: |
<reactivationtimestamp> |
Date and Time (in GMT) the reactivation occurred. Sent URL-encoded. Example: 7%2f28%2f2008+3%3a38%3a43+PM+(GMT+STANDARD+TIME) Example URL Decoded: 7/28/2008 3:38:43 PM (GMT STANDARD TIME) Available for these Postback Types: |
<nextbilldate> |
Next rebill date for re-activated subscription: mm/dd/yyyy Available for these Postback Types: |
<lastbilldate> |
The last date the re-activated subscription was billed: mm/dd/yyyy Available for these Postback Types: |
<extra ref1> through <extra ref10> |
Ref Variables are merchant reference variables. Segpay will store these variables along with the transaction, and they can be retrieved at a later time. Unlike user-defined variables, Ref values are encrypted in our database and passed back in all reports. Available for these Postback Types: |
<extra xxxx> |
All variables that are passed in on the pay page request via GET or POST variables will be matched to any “extra” variables and returned. Available for these Postback Types: |
<ccfirst6> |
First 6 digits of the card number (the BIN number). The merchant needs to be configured to be able to receive this variable. Available for these Postback Types: |
<cclast4> |
Last 4 digits of the card number. The merchant needs to be configured to be able to receive this variable. Available for these Postback Types: |
<authcode> |
Represents the response code for a transaction. Should use the normalized bank response table to return the appropriate decline message to the merchant. Available for these Postback Types: |
<ccbincountry> |
Two-character ISO code representing the country associated with the credit card BIN value. Available for these Postback Types: |
<refundreasoncode> |
Reason code the user chose when refunding the transaction. Only passed back for refund and void transactions. Available for these Postback Types: |
<refundcomment> |
The additional comment entered when a refund or void is processed. Only passed back for refund and void transactions. Available for these Postback Types: |
<refundedby> |
Name of the consumer that refunded the transaction. Only passed back for refund and void transactions. Available for these Postback Types: |
<cancelreasoncode> |
Reason code the consumer chose when refunding the transaction. Only passed back for refund and void transactions. Available for these Postback Types: |
<cancelcomment> |
The additional comment entered when a cancellation is processed. Only available in the cancellation postback. Available for these Postback Types: |
<cancelledby> |
Name of the consumer that cancelled the transaction. Only available in the cancellation postback. Available for these Postback Types: |
<cardtype> |
Available values are: Visa, MasterCard, JCB, Discover, eCheck and DirectDebit. Available for these Postback Types: |
<extra browsertype> |
Browser type identified at the time of the transaction. Can include a variety of values as there are many different browser types. Available for these Postback Types: |
<extra browserversion> |
Browser version identified at the time of the transaction. Example: Mozilla%2f5.0+(Windows+NT+6.3%3b+WOW64)+AppleWebKit%2f53 Available for these Postback Types: |
<extra ipcountry> |
Two-character ISO country code associated with the IP address for the transaction. Available for these Postback Types: |
<extra ismobiledevice> |
Values are: True or False, to indicate if transaction originated on a mobile device. Available for these Postback Types: |
<extra platform> |
The platform identified at the time of the transaction. Available for these Postback Types: |
<extra template> |
Paypage template associated with the package for the transaction. Available for these Postback Types: |
<prepaidindicator> |
Values are: Y or N, to indicate if payment was made via a prepaid card. Available for these Postback Types: |
<urlid> |
Numeric value representing the website ID in the Segpay system. Available for these Postback Types: |
<singleusepromo> |
Values are: Yes or No, to indicate whether a sale is associated with a single-use promotion. NOTE: This parameter is programmatically added to a postback for all single use promo transactions. Available for these Postback Types: |
<SCArequired> |
Values are: Yes or No, to indicate if transaction required Strong Customer Authentication, via 3-D Secure, in accordance with PSD2 regulations (NOT CURRENTLY BEING ENFORCED). Notes: - Applies to Europe-to-Europe transactions in regions where PSD2 will be enforced. The SCArequired parameter is added to custom postbacks even if not specified in the URL string. Available for these Postback Types: |
<3DSauthenticated> |
Values are: Yes or No, to indicate if customer was authenticated via 3-D Secure. NOTE: The 3DSauthenticated parameter is added to custom postbacks even if not specified in the URL string. Available for these Postback Types: |
<3DSauthenticationtype> |
NOT CURRENTLY USED. Will include type of 3-D Secure authentication used. Available for these Postback Types: |
<authprice> |
Converted amount, in an Amount Verification transaction, according to your base currency and the exchange rate on the day of the transaction. Available for these Postback Types: |
<authcurrency> |
Currency used for Amount Verification transaction, based on consumer’s selection. Available for these Postback Types: |