Postback Parameters

In online payment processing, a postback is a server-to-server communication used to notify you of events or actions related to transactions processed through Segpay. And postback parameters provide detailed information about these events, enabling you to integrate Segpay's services seamlessly with your systems.

Each parameter consists of a key (the parameter's name) and a value (the data it holds). You have the flexibility to create custom postbacks by adding specific parameters to the postback URL, allowing you to receive only the information essential for your needs. This streamlines your data processing and reduces unnecessary data transfer.

Default Postback vs. Custom Postback

  • Default Postback: When you don't specify any parameters in the postback URL, you'll receive a default postback containing all available parameters relevant to that specific postback type. This ensures you get comprehensive information about the event.

  • Custom Postback: You have the flexibility to create a custom postback by adding specific parameters to the postback URL. This allows you to receive only the information that's essential for your needs.

  • Customize your postbacks to receive only the data you need by adding specific parameters to the postback URL.

  • You can arrange the parameters within the postback URL in any order you prefer.

  • If you omit parameters, you'll receive a default postback containing all available parameters for that postback type.

  • For more information on setting up postbacks and examples, see our article, Postbacks.

Available Postback Parameters

Refer to the comprehensive table for a the complete list of postback parameters and the postback types they can be used with.

Postback Parameter Description Data Type Available Postback Types
<3DSauthenticated> Indicates the customer was authenticated via 3-D Secure (Yes/No). String (Yes/No) Transaction
<3DSauthenticationtype>

NOT CURRENTLY USED. Will include type of 3-D Secure authentication used.

 String Transaction
<action> The action that triggered this postback. String Inquiry,
Access Enable,
Access Disable,
Cancellation,
Reactivation,
Transaction
<approved>

Indicates transaction status.

  • Yes: Authorized

  • No: Declined

 String (Yes/No) Inquiry,
Access Enable,
Transaction
<authcode> Response code for a transaction. String/Integer Transaction
<authcurrency> Currency used for Amount Verification transaction based on consumer's selection. String Transaction
<authprice> Converted amount, in an Amount Verification transaction, according to your base currency and the exchange rate on the day of the transaction. Decimal Transaction
<billaddr> Consumer’s billing street address. Collected on the pay page or passed to Segpay. String Inquiry,
Access Enable,
Transaction
<billcity> Consumer’s billing city. Collected on the pay page or passed to Segpay String Inquiry,
Access Enable,
Transaction
<billcntry> Consumer's billing country (two-character ISO code). Collected on the pay page or passed to Segpay. String Inquiry,
Access Enable,
Transaction
<billemail> Consumer’s e-mail address. String Inquiry,
Access Enable,
Transaction
<billname> Consumer’s first and last name. String Inquiry,
Access Enable,
Reactivation,
Transaction
<billnamefirst> Consumer's first name. String Inquiry,
Access Enable,
Reactivation,
Transaction
<billnamelast> Consumer’s last name. String Inquiry,
Access Enable,
Reactivation,
Transaction
<billphone> Consumer's phone number. Collected on the pay page or passed to Segpay. String Inquiry,
Access Enable,
Transaction
<billstate> Consumer’s billing state. Collected on the pay page or passed to Segpay. String Inquiry,
Access Enable,
Transaction
<billzip> Consumer’s billing zip code. Collected on the pay page or passed to Segpa String Inquiry,
Access Enable,
Transaction
<cancelcomment> Additional comment entered when a cancellation is processed. Only available in the cancellation postback. String Cancellation, Transaction
<cancelledby> Name of the consumer that cancelled the transaction. Only available in the cancellation postback. String Cancellation, Transaction
<cancelreasoncode> Reason code chosen for canceling the transaction (refunds and void transactions only). String/Integer Cancellation, Transaction
<cardtype> Type of card used: Visa, MasterCard, JCB, Discover, eCheck, DirectDebit String Transaction
<ccbincountry> Two-character ISO country code associated with the credit card BIN. String Transaction
<ccfirst6> First 6 digits of the card number (BIN). Requires configuration of merchant account to receive this variable. String/Integer Transaction
<cclast4> First 4 digits of the card number. Requires configuration of merchant account to receive this variable. String/Integer Transaction
<currencycode>

The currency used for the transaction:

  • USD: US Dollar

  • EUR: Euro

  • GBP: British Pound

 String Inquiry,
Access Enable,
Reactivation,
Transaction
<desc> Bill configuration description. String Inquiry,
Access Enable,
Transaction
<eticketid> PackageID:BillConfigID (Signup and Stand-In only). String Inquiry,
Access Enable,
Reactivation,
Transaction
<extra browser type> Browser type identified at the time of the transaction. String Inquiry,
Access Enable,
Transaction
<extra browser version> Browser version identified at the time of the transaction. String Inquiry,
Access Enable,
Transaction
<extra ipcountry> Two-character ISO country code associated with the IP address for the transaction. String Inquiry,
Access Enable,
Transaction
<extra ismobiledevice> Indicates if the transaction originated on a mobile device (True/False). Boolean Inquiry,
Access Enable,
Transaction
<extra merchantpartnerid>

The Affiliate ID passed to Segpay when the transaction executes.

Assign a unique value for the affiliate to help Segpay detect potential fraudulent activities such as excessive trial sign-ups or unauthorized card use.

String/Integer Inquiry,
Access Enable,
Transaction
<extra password> Password collected on the pay page. String Inquiry,
Access Enable,
Access Disable,
Cancellation,
Reactivation,
Transaction
<extra platform> The platform identified at the time of the transaction. String Inquiry,
Access Enable,
Transaction
<extra ref1>
through
<extra ref10>		 Merchant reference variables stored with the transaction and retrievable later. Ref values are encrypted and passed back in all reports. String Inquiry,
Access Enable,
Transaction
<extra template> Paypage template associated with the package for the transaction. String Inquiry,
Access Enable,
Transaction
<extra username> Username collected on the pay page. String Inquiry,
Access Enable,
Access Disable,
Cancellation,
Reactivation,
Transaction
<extra xxxx> All variables passed in the pay page request via GET or POST, matched to any "extra" variables and returned. String Inquiry,
Access Enable,
Transaction
<iint> Length, in days, of the Initial billing period (trial). Integer Inquiry,
Access Enable,
Transaction
<ipaddress> Consumer's IP address. String Inquiry,
Access Enable,
Transaction
<ival> Initial transaction amount authorized for the sale. Decimal Inquiry,
Access Enable,
Transaction
<lastbilldate> The last date the reactivated subscription was billed (mm/dd/yyyy). Date Reactivation
<nextbilldate> Next rebill date for reactivated subscription (mm/dd/yyyy). Date Reactivation
<paymentaccountid> Secure ID to uniquely identify the credit card used. String Transaction
<prepaidindicator> Indicates if payment was made via a prepaid card (Y/N). String (Y/N) Inquiry,
Access Enable,
Transaction
<price> Transaction amount. See <currencycode> for currency type. Decimal Inquiry,
Access Enable,
Transaction
<purchaseid> Purchase ID of the transaction. String Inquiry,
Access Enable,
Access Disable,
Cancellation,
Reactivation,
Transaction
<reactivationtimestamp> Date and time (GMT) the reactivation occurred. URL-encoded. String Reactivation
<refundcomment> Additional comment entered when a refund or void is processed (for refunds and voids only). String Access Disable,
Transaction
<refundreasoncode> Reason code indicating why the transaction was refunded (for refunds and voids only). String/Integer Access Disable,
Transaction
<refundedby> Name of the consumer who refunded the transaction (for refunds and voids only). String Access Disable,
Transaction
<relatedtranid> Transaction ID of the original sale (for refunds, voids, chargebacks, revokes). String/Integer Transaction
<rint> Length, in days, of the recurring billing period. Integer Inquiry,
Access Enable,
Transaction
<rval> Recurring billing amount. 0 if no recurring amount. Decimal Inquiry,
Access Enable,
Reactivation,
Transaction
<SCArequired>

Indicates if the transaction required Strong Customer Authentication (SCA) via 3-D Secure (Yes/No). Not currently enforced.

Applicable for Europe-to-Europe transactions in regions where PSD2 is enforced; the SCA-required parameter is added to custom postbacks even when not specified in the URL string.

 String
(Yes/No)		 Transaction
<singleusepromo>

Indicates whether a sale is associated with a single-use promotion (Yes/No).

Parameter is programmatically added to a postback for all single-use promo transactions.

String
(Yes/No)		 Transaction
<stage>

The type of transaction that triggered the event:

  • Initial: First transaction of this type.

  • Conversion: First rebill of a subscription.

  • Rebill: Subsequent rebill transactions after a conversion.

  • Instantconversion: Consumer converted before the original conversion date.

String Inquiry,
Access Enable,
Transaction
<standin> Indicates if a stand-in occurred:
-1 = Stand-In not supported.
0 = No Stand-In occurred
1 = Stand-In occurred.		 Integer Inquiry,
Access Enable,
Transaction
<tranid> Transaction ID. String Inquiry,
Access Enable,
Transaction
<transguid>

Used for Instant Conversions. Segpay assigned the Global Unique Identifier (GUID) to the transaction.

Parameter is programmatically added to a postback for all instant conversion transactions.

 String Inquiry,
Access Enable,
Transaction
<transtime>

Indicates the date and time the transaction occurred. Sent URL-encoded.

Example URL-encoded: 7%2f28%2f2024+3%3a38%3a43+PM+(GMT+STANDARD+TIME)

Example URL Decoded: 7/28/2024 3:38:43 PM (GMT STANDARD TIME)

 String Inquiry,
Access Enable,
Transaction
<trantype>

TranType:

  • CB Reversal = Chargeback Reversal

  • Charge = chargeback

  • Credit = refund

  • RDRreversal = RDR Reversal (Rapid Dispute Response)

  • Sale = sale

 String Inquiry,
Access Enable,
Transaction
<urlid> Numeric value representing the website ID in the Segpay system. Integer Inquiry,
Access Enable,
Access Disable,
Reactivation,
Transaction
<xsellnum> Used for cross sells.
0 = Main Transaction
1 = First cross sell
2= Second cross sell. 		Integer Inquiry,
Access Enable,
Transaction