Skip to main content
knowledgecenter.2checkout.com

INS parameters

Overview

Depending on your INS settings, notifications contain all or a subset of the available parameters. 2Checkout sends INS parameters in the exact order listed in this article.

For each trigger enabled, you are able to select which URL endpoint receives the notification, as well as customize the list of parameters included in the notification. Read more about INS parameters here.

Note: 2Checkout continues to add new INS parameters on an ongoing basis. To include additional information in the notifications, enable new parameters in the INS settings page.

Parameter Description Type
message_type Indicates the type of message String
message_description The description of message_type String
timestamp Timestamp of event; format YYYY-MM-DD HH:MM:SS ZZZ Timestamp
md5_hash Hash calculated for the notification. String
message_id This number is incremented for each message sent to a given seller Integer
key_count Indicates the number of parameters sent in a message Integer
vendor_id Merchant account number Integer
sale_id 2Checkout sale number Integer
sale_date_placed Date of sale; format YYYY-MM-DD Date
vendor_order_id Custom order id provided by seller, if available. (“merchant_order_id” can be passed into the checkout with the sale parameters) String
invoice_id 2Checkout invoice number; Each sale can have several invoices, most commonly one per installment billed on a recurring order. Integer
recurring recurring=1 if any item on the invoice is a recurring item, 0 otherwise Integer
payment_type Customer’s payment method. String
list_currency 3-Letter ISO code for seller currency String
cust_currency 3-Letter ISO code for customer currency String
auth_exp The date credit authorization will expire; format YYYY-MM-DD Date
invoice_status Status of a transaction (approved, pending, deposited, or declined) String
fraud_status Status of 2Checkout fraud review (pass, fail, or wait); Can be NULL. String
invoice_list_amount Total in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY) Integer
invoice_usd_amount Total in US Dollars; format with 2 decimal places Integer
invoice_cust_amount Total in customer currency; format as appropriate to currency (2 decimal places for most, integer for JPY) Integer
customer_first_name Customer’s first name (may not be available on older sales) String
customer_last_name Customer’s last name (may not be available on older sales) String
customer_name Customer’s full name (name as it appears on credit card) String
customer_email Customer’s email address String
customer_phone Customer’s phone number; all but digits stripped out Integer
customer_ip Customer’s IP address at time of sale String
customer_ip_country Country of record for customer’s IP address at time of sale; Please note in some cases what is returned is not a country, Ex. Satellite Provider String
bill_street_address Billing street address String
bill_street_address2 Billing street address line 2 String
bill_city Billing address city String
bill_state Billing address state or province String
bill_postal_code Billing address postal code String
bill_country 3-Letter ISO country code of billing address String
ship_status Value will be not_shipped, shipped, or empty (if intangible / does not need shipped) String
ship_tracking_number Tracking Number as entered in Seller Admin String
ship_name Shipping Recipient’s name (as it should appears on shipping label) String
ship_street_address Shipping street address String
ship_street_address2 Shipping street address line 2 String
ship_city Shipping address city String
ship_state Shipping address state or province String
ship_postal_code Shipping address postal code String
ship_country 3-Letter ISO country code of shipping address String
item_count Indicates how many numbered sets of item parameters to expect Integer
item_name_# Product name String
item_id_# Seller product id String
item_list_amount_# Total in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY) Integer
item_usd_amount_# Total in US Dollars; format with 2 decimal places Integer
item_cust_amount_# Total in customer currency; format as appropriate to currency (2 decimal places for most, integer for JPY) Integer
item_type_# Indicates if item is a bill or refund; Value will be bill or refund String
item_duration_# Product duration, how long it re-bills for Ex. 1 Year String
item_recurrence_# Product recurrence, how often it re-bills Ex. 1 Month String
item_rec_list_amount_# Product price; format as appropriate to currency (2 decimal places for most, integer for JPY) Integer
item_rec_status_# Indicates status of recurring subscription. Ex: canceled, completed String
item_rec_date_next_# Date of next recurring installment; Date
item_rec_install_billed_# The number of successful recurring installments successfully billed Integer
order_ref The reference number of the 2Checkout order. String
order_no The number of the 2Checkout order. Available only after the sale is risk approved. String

 Proposal Updated Parameters

Parameter Description Type
message_id The unique identifier of the proposal message. String
updated_date The date and time when then the proposal was last time updated; format YYYY-MM-DD HH:MM:SS ZZZ. Datetime
source The platform where the proposal was created. String
tac The Terms and Conditions content. String
accepted_date The date and time when then the proposal was accepted; format YYYY-MM-DD HH:MM:SS ZZZ. Datetime
status

The proposal status. Possible values:

  • opened
  • sent
  • closed_won
  • closed_lost
  • declined
  • expired
  • accepted
String
message_type The type of message sent with the proposal. String
key_count Indicates the number of parameters sent in a message. Number
proposal_id Unique identifier of the proposal generating the offer. Can be found in Order additional information as text. String
created_by The unique external system user identifier that created the proposal. String
content The proposal content. String
type The type of proposal (new acquisition, renewal, upgrade). String
expiration_date The UTC expiration date for the proposal, set only when the status is changed to "sent". Datetime
message_description The description of message_type. String
version The proposal version. Integer
updated_by The external system user ID that performed the last update on the proposal. String
bill_to Billing details. String
sent_by The account manager who sent out the proposal. String
status_comment The associated comment on the status of the proposal. String
timestamp Timestamp of event; format YYYY-MM-DD HH:MM:SS ZZZ. Datetime
created_date The date and time when then the proposal was created; format YYYY-MM-DD HH:MM:SS ZZZ. Datetime
locked The proposal is locked to buy modifications. String
name The name of the proposal. String
links

The proposal links details. Can be:

  • Proposal User Interface Access URL
  • Download PDF URL
String
sell_to The entity using the proposal service. String
md5_hash Hash calculated for the notification. String

 

  • Was this article helpful?