Skip to main content
knowledgecenter.2checkout.com

INS triggers

Note to user NOTE:  Instant Notification Service (INS) is available only to merchants migrated from 2Checkout 1.0 platform.

Set INS triggers

In your Control Panel Dashboard, navigate to Dashboard → Integrations → Webhooks and API and click on the INS settings tab. Select the events for which 2Checkout sends notifications from the list of options available under Triggers.

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.

Instant Notification Service (INS) provides automatic notifications for orders from the 2Checkout system, based on the following list of triggers you control:

Trigger Message type Description
Order created ORDER_CREATED Order creation is a new order placed online by a buyer. You may want to automate inventory management, fulfillment or setup of login credentials based on this message.
Fraud status changed FRAUD_STATUS_CHANGED

All orders must pass 2Checkout’s fraud review before they will be billed; therefore sellers are advised that goods should not be delivered until they have passed this fraud review. If an order fails the fraud review it will also be canceled. An order may change fraud status more than once.

Fraud Status Changed is an invoice level message; it will be sent once for each fraud status change on a sale and will contain information about all items ordered.

Invoice status changed INVOICE_STATUS_CHANGED

This status indicates the progress of the payment process. Most orders go from ‘approved’ to ‘pending’ to ‘deposited’, at which point they are applied to your balance.

Invoice Status Changed is an invoice level message; it will be sent once for each status change on an invoice and will contain information about all items ordered.

Ship status changed SHIP_STATUS_CHANGED

This message indicates that the ship_status of an order has changed, from ‘not_shipped’ to shipped (e.g. when an order is marked shipped).

Ship Status Changed is an invoice level message; it will be sent once for each shipping status change on an invoice and will contain information about all items ordered.

Refund issued REFUND_ISSUED

This message will allow you to automate more accurate inventory and financial tracking.

Refund Issued is an item level message; it will be sent once for each refund item issued (product or partial) and will only contain information about that item.

Recurring stopped RECURRING_STOPPED

Recurring orders can be stopped by the buyer or the seller. This message will notify you when a recurring sale has been stopped so that you can disable the buyer’s service in your application.

Recurring Stopped is an item level message; it will be sent once for each recurring item stopped and will only contain information about that item.

Recurring restarted RECURRING_RESTARTED

After being stopped, recurring orders can be restarted by 2Checkout staff for a variety of reasons, the most common being per customer request. In this most common case, a customer calls 2Checkout and requests to restart billing on a recurring order.

Recurring Restarted is an item level message; it will be sent once for each recurring item restarted and will only contain information about that item.

Recurring installment success RECURRING_INSTALLMENT_SUCCESS

Recurring orders bill automatically according to schedule. This message will allow you to automate any processes which should be keyed off successful installment billing, such as extension of login credentials.

This message will send the same customer information and sale_id (and vendor_order_id, if provided) as the original Order Created message, however the successful billing will have generated a new invoice_id and will have incremented the item_rec_install_billed_# parameter.

Recurring Installment Success is an item level message; it will be sent once for each recurring item billed successfully and will only contain information about that item.

Recurring installment failed RECURRING_INSTALLMENT_FAILED

Recurring orders bill automatically according to schedule, but billings are not always successful. This message will allow you to automate any processes which should be keyed off installment billing failure, such as suspension of login credentials.

This message will send the information based on the last successful installment billed, in other words, the invoice number is the last invoice successfully billed, installments_billed is not incremented, and date_next will often be a date in the past, indicating the original due date for the missed billing.

Recurring Installment Failed is an item level message; it will be sent once for each recurring item which fails to bill and will only contain information about that item.

Recurring complete RECURRING_COMPLETE

Recurring orders bill automatically according to schedule, which ends a fixed amount of time after original order placement. This message will allow sellers to automate any processes which should be keyed off completion of installment billing, such as issuing permanent credentials or account closure.

Please Note: The RECURRING_INSTALLMENT_SUCCESS message will also be sent prior to the RECURRING_COMPLETE message.

Recurring Complete is an item level message; it will be sent once for each recurring item completed and will only contain information about that item.

 

  • Was this article helpful?