IPN parameters

Allows shoppers to gift the subscription/product acquired to the recipient specified using the delivery details during the purchase process. Possible values:

• 0 – Not a gift order.
• 1 – Gift order. The subscription/product is a gift.

Available for subscription renewals.

Array of REFNOEXT (the external order reference - max. 100 chars) values set for the initial orders when the subscriptions were first acquired.

Current order status. Possible values are:

• PENDING - Order placed, waiting bank authorization.

• PAYMENT_AUTHORIZED – The bank authorized the payment.

• SUSPECT – 2Checkout is reviewing the order having flagged it as a potential fraud attempt. Note: Not available by default. Contact 2Checkout directly to start receiving this order status.

• INVALID – Invalid Billing/Delivery information.

• COMPLETE – 2Checkout marked the order as complete.

• REFUND – 2Checkout refunded the money paid back to the shopper. 2Checkout can only refund complete orders.

• REVERSED – 2Checkout reversed a transaction and released the money back to the customer. 2Checkout can only reverse authorized orders that never reach the complete status.

• PURCHASE_PENDING – Sent for orders placed using Purchase Orders after you approve the PO. 2Checkout is waiting for the customer to make the payment.

• PAYMENT_RECEIVED – 2Checkout sends this notification when it received payment for orders with offline payment methods such as bank/wire transfer.

• CANCELED - The 2Checkout system sends out notifications when:

• 2Checkout representatives cancel eStore orders (only for orders that are not authorized/paid, otherwise a reverse or refund action is required).
• Partner (Channel Manager) orders you cancel yourself.

• PENDING_APPROVAL - 2Checkout has yet to approve this order.

Payment method code.

Possible values:

Shopper card type. When shoppers use multiple cards, 2Checkout includes the type of the last card used in the IPN - e.g. "Visa".

Empty for non-card transactions.

The last 4 digits of the shopper credit/debit card. When shoppers use multiple cards, 2Checkout includes the last four digits of the last card used in the IPN - e.g. "Visa".

 Empty for non-card transactions.

Order shipment status. Possible values:

• TRUE - for shipped orders
• FALSE - for orders that are not shipped

Chargeback status information. Possible values:

· OPEN (chargeback is in progress)

· WON (chargeback won by you)

· LOST (chargeback won by the customer)

· ACCEPTED (you agreed to repay the value of the order to the customer)

· NONE (no chargeback initiated for the order)

To manage chargeback notifications navigate to Control Panel Dashboard →Integrations → Webhooks and API, and click on the IPN settings tab.

In the General IPN Settings section, under Triggers, make sure to check the boxes next to the following options:

· chargeback open (2Checkout sends an IPN when shoppers open a chargeback dispute).

· chargeback closed - (2Checkout sends an IPN when the parties involved resolve a chargeback dispute).

Also, check the checkbox next to the CHARGEBACK_RESOLUTION parameter featured in the Response tags area.

Identifier for the chargeback dispute reason from the 2Checkout system. Empty for orders with no chargeback dispute initiated.

Possible values:

• MERCHANDISE_NOT_RECEIVED - Order not fulfilled/not delivered
• NOT_AS_DESCRIBED - Product(s) not as described/not functional
• DUPLICATE_TRANSACTION - Duplicate order
• FRAUD / NOT_RECOGNIZED - Fraud/Order not recognized
• CREDIT_NOT_PROCESSED - Agreed refund not processed
• NOT_RECOGNIZED - New/renewal order not recognized
• AUTHORIZATION_PROBLEM - Authorization problem
• INFO_REQUEST - Information request
• UNKNOWN - Unknown
• CANCELED_RECURRING - Recurring payment was canceled

Possible values:

• 1 - for test orders

• 0 - for real orders

Source of the order placed. Possible values:

• Automatic Billing 
• WEB 
• Mobile
• API

Refund reason.

Possible value can be one of the refund reasons defined in the platform:

• Chargeback
• Duplicate order
• Not satisfied with the product
• Product not received
• Unwanted auto-renewal
• Technical issue with the product
• Other
• No reason

If you have set your own refund reasons, the value corresponds to the reasons selected in the refund process from your customized reasons.

Click here to learn how to customize your refund reasons.

Possible values:

• APPROVED for orders with a low fraud risk that passed the fraud screening.
• DENIED for orders with high score risk that were automatically rejected by the fraud engine.
• UNDER REVIEW for orders with a high fraud risk that require manual review and approval before the charge can be collected.
• PENDING for orders that are yet to enter the fraud screening.

The name of the event triggering the notification.

Currency used in order.

Possible values:

• USD 
• EUR 
• GBP

Depending on your account settings, other currencies might be available.

Array of strings. Allows you to see how the custom price is calculated and is included in the IPN message you receive after an order. It contains the following variables: 

• Product ID
• License code   
• TYPE – Possible values: 
  
  • GROSS 
  • NET  
  • empty 
• SOURCE_NAME – Possible values: 
  
  • the name of the promotion name for SOURCE_TYPE set to PROMOTION 
  • the name of the campaign for SOURCE_TYPE set to CHURN_CAMPAIGN or ENROL_CAMPAIGN 
  • empty for any other value of SOURCE_TYPE 
• SOURCE_TYPE – Possible values: 
  
  • GROSS  
  • NET  
  • empty  
  • SYSTEM 
  • CPANEL 
  • API 
  • IMPORT 
  • PROMOTION 
  • CHURN_CAMPAIGN
  • ENROL_CAMPAIGN
  • ASSISTED_SALE 
  • PRICING_CONFIGURATION 
  • DYNAMIC_PRODUCT 
  • n/a 
• DISCOUNT_VALUE – The amount of the discount 
• DISCOUNT_TYPE – Possible values: 
  
  • PERCENT 
  • FIXED 
• DISCOUNT_CURRENCY –Possible values: 
  
  • 3 letter currency code of the discount for DISCOUNT_TYPE set to FIXED 
  • empty for any other DISCOUNT_TYPE 

Example :

[CUSTOM_PRICE] => Array

(

[31029265] => Array

(

[H17120HBAY] => Array

(

[AMOUNT] => 80

[TYPE] => NET

[CURRENCY] => USD

[SOURCE_NAME] => custom price regular

[SOURCE_TYPE] => PROMOTION

[DISCOUNT_VALUE] => 20

[DISCOUNT_TYPE] => FIXED

[DISCOUNT_CURRENCY] => USD

)


)


)

Payment interface language. Current possible values:

• ar العربية Arabic
• bg български език Bulgarian
• cs Česky Czech
• da Dansk Danish
• de Deutsch German
• el Ελληνικά Greek
• en English
• es Español Spanish
• fa فارسی Persian
• fi Suomi Finnish
• fr Français French
• he Hebrew עִבְרִית
• hi Hindi
• hr Hrvatski jezik Croatian
• hu Magyar Hungarian
• it Italiano Italian
• ja 日本語 Japanese
• ko 한국어 Korean
• nl Nederlands Dutch
• no Norsk Norwegian
• pl Polski Polish
• pt Português Portuguese
• pt-br Português do Brasil Brazilian Portuguese
• ro Română Romanian
• ru Русский Russian
• sk Slovenčina Slovak
• sl Slovène Slovenian
• sr Serbian
• sv Svenska Swedish
• th ไทย Thai
• tr Türkçe Turkish
• zh 中文 Chinese Simplified(Cantonese)
• zy 繁体中文 Chinese Mandarin Traditional

String/2

String/5

The type of ordering flow used for placing the order. Available values:

• PURCHASE_ORDER (when customers use a Purchase Order).

• REGULAR (default, with the exception of scenarios in which customers use POs).

Array with the type of subscription purchased for each product. Possible values:

• REGULAR (new license)
• RENEWAL (renewal for an old license) 
• UPGRADE (an upgrade to an existing license) 
• TRIAL

Array with the names of all the price options, where 1234 represents the 2Checkout product ID.

For usage scale pricing option groups, 2Checkout returns the name of the pricing options as well as the number of units of metered resources consumed by the customer. Format: 'PricingOptionsGroupName: NumberOfUnitsConsumed', for example 'GBs: 100'.

Array with unique codes set up for the pricing option groups, where1234 represents the product ID.

In the case of usage scale pricing options groups, 2Checkout return both the unique code of the group as well as the number of units of metered resources consumed by the customer. Format: 'UniqueCode: NumberOfUnitsConsumed', for example 'meteredGBs: 100'.

Array with optional codes (unique for pricing option group), where 1234 represents the product ID.

In the case of usage scale pricing options groups, 2Checkout returns both the unique code of the group as well as the number of units of metered resources consumed by the customer. Format: 'UniqueCode: NumberOfUnitsConsumed', for example 'meteredGBs: 100'.

Array with all prices corresponding to each option (prices are in the order currency), where 1234 represents the product ID.

In the case of usage scale pricing options groups, it will return the price of the metered resources consumed by the customer in the order currency.

Array with all price operators corresponding to each price option, where 1234 represents the product ID 
Possible values:

• ADD 
• SUBSTRACT

Designed to differentiate usage pricing options groups from non-usage pricing options groups.

Possible values:

• PREPAID - for orders involving products with pricing options groups of the following type: Radio, Dropdown, Checkbox and Scale (but without a metered cost component (usage scale pricing)). 
• POSTPAID - for orders involving products with a metered cost component (usage scale pricing).

Array indicating the products shoppers purchased opting for the lifetime/evergreen option.

Possible values:

• YES = lifetime subscription
• NO

Possible values:

• Empty = ecommerce order
• Partner code

This parameter, sent along with the notifications provided for orders placed in the 2Checkout system, offers additional info for refunds processed. REFUND_TYPE describes the type of the refund, total or partial. As such, the parameter can have two possible values:

• TOTAL – 2Checkout paid back the entire sum paid for the initial order.
• PARTIAL – 2Checkout paid back only a percentage of the amount paid for the initial order.

REFUND_TYPE is empty for orders that are not refunds.

Array with the category of the promotions you configured and are included in the order.

Possible values:

• CROSS_SELLING
• UPSELL
• PROMOTION

Calculated HMAC_MD5 signature based on the sent IPN fields and the secret key.

(Note: This parameter won't be used anymore for IPN validation as of 15th of August, 2024.)