Interaction Specification When Receiving Webhooks

MIME-type. It must be equal to "application/json".

Webhook signature.
Webhook signature verification allows you to rest assured that the webhooks received are from Softline.
Format: hash, generated with algorithm SHA-512, from string:

[secret key];[event];[order_id];[create_date];[payment_method];[currency];[customer.email]

where:

• secret key - when setting up webhooks.
• event; order_id; create_date; payment_method; currency; customer.email - the values coincide with the values of the corresponding webhook fields.

See the signature generation example.

Notification-triggering event.
For the value options, see the reference guide.

Date and time of event
The system send a webhook on this event

Format: YYYY-MM-DDThh:mm:ss±hh:mm.

(For orders in Softline Checkout) Order identifiers.

(For payments in Softline Payments) Payment identifiers.

Extended order/payment identifier.
In such a format prefixes can be added to identifiers.

(For orders in Softline Checkout) This is the way order numbers are viewed by customers.

Order/payment status.
Value options:

• not paid
• paid
  (For payments in Softline Payments) The status is also used if the card verification process initiated by the /v1/payment/card/verification request has been successfully completed.
• deleted
  The status is also used if a full refund has been made.

More details on order statuses.

(For orders in Softline Checkout) Checkout page identifier.
It is used if an order for a product with dynamic characteristics has been placed. You receive this identifier in response to the request used for generating a buy link to purchase a product with dynamic characteristics (buy_link).
Otherwise, the parameter is transferred having an empty value ("").

(For payments in Softline Payments) Payment identifiers on your end.
This identifier is filled with a value from the payment_id parameter when creating a payment object or processing an auto-payment.

Date and time of creation for order/payment object.
If a webhook is sent on the order.created event, the date and time values in this parameter will be equal to the values transferred in event_date.

Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Date and time of successful order payment/payment completion
If a webhook is sent on the order.payment.succeeded event, the date and time values in this parameter will be equal to the values transferred in event_date.

• Format: YYYY-MM-DDThh:mm:ss±hh:mm.
• If no payment has been made, the parameter is transferred having an empty value ("").

Currency code of order/payment.

• Format: ISO 4217 alpha-3, 3 characters.
• For the value options, see the reference guide.

Checkout page interface language
For the value options, see the reference guide.

(For orders in Softline Checkout) Link leading to the order page.
When receiving webhooks in the test environment - links will be intended for the test environment (links will have the .demoslweb.com suffix added).

(For payments in Softline Payments) Link leading to the payment form page.

Customer data.

Customer's country code.

• Format: ISO 3166-1 alpha-2.
• For the value options, see the reference guide.

Customer type.
Value options:

• physical - natural person.
• juridical - legal person.

Customer's email.

Customer's name.

Customer's last name.

Customer's phone number.
If the parameter contains no value on our end, it is transferred empty ("").

Taxpayer identification number.
E.g., it is used to transfer:

• DNI/CUIL/CUIT when payments are made in Argentine pesos.

If the parameter contains no value on our end, it is transferred empty ("").

Company name.
If the parameter contains no value on our end, it is transferred empty ("").

Company's registered office address.
If the parameter contains no value on our end, it is transferred empty ("").

Company’s physical address.
If the parameter contains no value on our end, it is transferred empty ("").

(For orders in Softline Checkout) Order product data.

(For payments in Softline Payments) Payment data.

(For orders in Softline Checkout) Product identifiers.

(For payments in Softline Payments) Technical values.

(For orders in Softline Checkout) Your product identifiers.
If the parameter contains no value on our end, it is transferred empty ("").

(For payments in Softline Payments) Technical values.

(For orders in Softline Checkout) Your product SKU.
If the parameter contains no value on our end, it is transferred empty ("").

(For payments in Softline Payments) Technical values.

Product sales business segment.
Value options:

• b2c - product is intended for individuals.
• b2b - product is intended for legal entities.
• mobile - mobile app.

If the parameter contains no value on our end, it is transferred empty ("").

(For orders in Softline Checkout) Full names of products.

(For payments in Softline Payments) Payment descriptions. This description is filled with values of the payment_description parameter when creating a payment object or processing an auto-payment.

(For orders in Softline Checkout) Price per product unit in order currency.
Format: String contains numerals; value separating by point, with two decimal places.

(For payments in Softline Payments) Payment amount excluding VAT.

(For orders in Softline Checkout) Product unit quantities.

(For payments in Softline Payments) "1" is always transferred.

(For orders in Softline Checkout) Product discount percentage.
It is transferred if a discount is applied to a product in an order at checkout. Otherwise, the parameter is transferred having an empty value ("").

(For payments in Softline Payments) It is not applicable.

(For orders in Softline Checkout) Product discount amount in order currency.
It is transferred if a discount is applied to a product in an order at checkout. Otherwise, the parameter is transferred having an empty value ("").
Format: String contains numerals; value separating by point, with two decimal places.

(For payments in Softline Payments) It is not applicable.

VAT percentage.

VAT amount in order currency.
(For orders in Softline Checkout) Product quantity in an order and a discount are taken into account.
Format: String contains numerals; value separating by point, with two decimal places.

(For orders in Softline Checkout) Product total price in order currency.

• Price due to product quantities, VAT and discounts.
• Format: String contains numerals; value separating by point, with two decimal places.

(For payments in Softline Payments) Payment total amount with VAT included.

You profit margin from sales in order currency.
Format: String contains numerals; value separating by point, with two decimal places.

(For orders in Softline Checkout) Product license information sent to customers.
The parameter is transferred if a product exploits the Softline automatic fulfillment tools (electronic delivery option) to send its license information, or the license information of the product has already been sent and the data has been saved in Softline.

(For payments in Softline Payments) It is not applicable.

Payment data.

Payment method code for order/payment.
For the value options, see the reference guide.

Payment method name of order/payment object.
(For orders in Softline Checkout) This name is seen by customers on the checkout page when they place an order.

Payment error code.
* - Required, if an error occurs during payment.

Payment error description.
* - Required, if an error occurs during payment.

Card expiration date.
The value can be transferred if:

• The customer has paid for their order with a card.
• The order was created to renew an AR subscription (child) but the customer has not paid for it yet. In this case, the parameter value is taken from the parent order if it was paid with a card.
• Format: MM/YYYY. Example: 12/2026.

Otherwise, the parameter is transferred with an empty value ("").

Attribute indicating whether card expires before subscription expiration date.
The value can be transferred if:

• The order contains a subscription (AR or PMR).
• A card is used for payment and its expiration date is set (the payment.card_expiration_date parameter was transferred). If the order was created to renew a subscription (child order) and the customer has not paid for it yet, the parameter value is taken from the parent order.

The current subscription status does not affect the parameter.

Value options:

• true - card expires before subscription expires.
• false - card expires after subscription has expired, т.е. [card expiration date] ≥ [subscription expiration date].

Last 4 digits of card number.
The value can be transferred if:

• The customer has paid for their order with a card.
• The order was created to renew an AR subscription (child) but the customer has not paid for it yet. In this case, the parameter value is taken from the parent order if it was paid with a card.

Otherwise, the parameter is transferred with an empty value (null).

Installment payment availability.
More details on payment in installments. This parameter and all the other ones concerning installment payment include only the installments of Softline Checkout (installments of PSP are not included).

Value options:

• true - no installments (one-time payment).
• false - installments.

One installment amount.

• * - Required, if payment.is_installment_payment is true, otherwise, it is not transferred
• Format: Numeral with 2 decimal places, separator - point. Transferred as a string.
• The amount of the last installment may slightly differ from the remaining installment amounts.

Currency code of one installment payment amount.

• * - Required, if payment.is_installment_payment is true, otherwise, it is not transferred.
• Always equals the value of the currency parameter.

Number of installments
* - Required, if payment.is_installment_payment is true, otherwise, it is not transferred.

(For orders in Softline Checkout) Subscription data.
It is transferred if an auto-renewable subscription (AR / AR Trial) or a pre-filled manual renewal (PMR) is issued for a product.

Note. Subscription creation happens upon successful order-initiator payment. Therefore, the subscription parameter is generally absent in the order.created event for such an order, since no subscription has been created by the time the order is created. There are two cases when the parameter may be present in the order.created event:

• The system sends the webhook notifying of the order created to renew the subscription.
• The system sends the webhook notifying of the order that is a subscription order initiator; and by the time the event is sent, the payment has been successfully completed, i.e. a subscription has been created.

(For payments in Softline Payments) It is not applicable.

Subscription identifier.

• * - Required, if the subscription parameter is transferred.
• Format: NN_MM, where NN is an identifier of the order that initiates subscriptions (parent order).

ID of previous order within subscription

• If a current order is a parent one and initiates a subscription, the parameter is transferred having value "null"
• If a current order is a child one, this parameter transfers the identifier of a previous child order (or the identifier of a parent order in case it is the first renewal)

* - Required, if the subscription parameter was transferred.

Example:
If a subscription included orders 0001 (subscription initiator), 0002 (1st subscription renewal), 0003 (2nd subscription renewal), and a webhook is sent upon the event that has happened to:

• Order 0001, then "order_id":0001, "subscription.previous_order_id":null
• Order 0002, then "order_id":0002, "subscription.previous_order_id":0001
• Order 0003, then "order_id":0003, "subscription.previous_order_id":0002

Note, the webhook on cancellation/resumption of the subscription is always sent for the parent order ("order_id":0001), so it will always transfer the following: "subscription.previous_order_id":null (regardless of any child orders existing at the time of the event happening to the subscription).

Subscription type.
* - Required, if the subscription parameter is transferred.

Value options:

• AR - auto-renewable subscription (including AR Trial).
• PMR - pre-filled manual renewal.

More details оn subscription types.

Attribute indicating first renewal after free trial period.
It indicates whether the order on which you received a webhook had been created or not to renew a subscription immediately after its free trial period expiration.
* - Required, if the subscription parameter is transferred.
Value options:

• true - if all the conditions are met:
  • The order renews an AR subscription. (The order is a child order. The subscription.type parameter equals AR).
  • This is the first child order of this subscription.
  • The subscription has a free trial period. (The customer purchased the parent product free of charge).
• false - if the conditions for transferring true are not met.

Subscription status.
* - Required, if the subscription parameter is transferred.

Value options:

• active - subscription is in progress and requires no payment.
• not paid - subscription is payment pending.
• cancelled - renewal is cancelled.

More details on the statuses of auto-renewable subscriptions (AR). Pre-filled manual renewal (PMR) subscriptions exploit the same statuses, however, the following options are not available: subscription cancellation or subscription restoration.

Product validity period.

• * - Required, if the subscription parameter is transferred.
• Format: ISO 8601 code: P[number][unit of measurement].
• Supported units: Y - year, M - month, D - day.
• Example: "P1Y" matches "1 year".

Subscription expiration date.

• * - Required, if the subscription parameter is transferred.
• Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Date of next attempt to pay for AR subscription.
Only the date of the first payment attempt is transferred. The system ignores additional attempts in case of unsuccessful payment. If the date comes but the attempt is unsuccessful, or the system runs out of all the attempts to pay for a subscription (the subscription has not been renewed), the data transferred does not change. The system calculates a new date to pay for the next renewal after successful payment.

• * - Required, if the subscription parameter was transferred and the subscription.type parameter equals AR.
• Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Link to manage auto-renewable subscriptions (AR, AR Trial). This anchor link leads to the subscription section within the subscription order initiator page.
* - Required, if the subscription parameter is transferred, and the subscription.type parameter is equal to AR. Otherwise, the parameter is not transferred.

Note:

• If a webhook notifies of a subscription order initiator (parent), the order_detail_url parameter and the subscription.detail_url parameter contain a link to the same page.
• If a webhook notifies of a renewal order (child), these parameters have different values: order_detail_url - leads to the renewal order page, а subscription.detail_url – leads to the subscription order initiator page.
• When receiving webhooks in the test environment - links will be intended for the test environment (links will have the .demoslweb.com suffix added).

(For orders in Softline Checkout) Additional parameters of order. More details on additional parameters. Please note that the time for storing additional parameters in orders is limited.

(For payments in Softline Payments) Values of the additional_data parameter in the payment creation request.

Parameter name.
* - Required, if the additional_data parameter is transferred.

Parameter value.
* - Required, if the additional_data parameter is transferred.

Refund / return data.

It is transferred if a webhook is sent on the product.returned event. Otherwise, it is not transferred.

Action type.
* - Required, if the return parameter is transferred.

Value options:

• returned - refund or replacement of license information.
• removed - removal of incorrect license information, e.g., when the customer receives invalid data instead of license information because of technical issues.

Date and time of event.
If a webhook is sent on the product.returned event, the date and time values in this parameter will be equal to the values transferred in event_date.

• * - Required, if the return parameter is transferred.
• Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Reason description for event.
* - Required, if the return parameter is transferred.

Value options:

• "Проблема установки / активации" - installation / activation problem.
• "Географически ограничения" - geo-restriction.
• "Ошибка при выборе продукта" - product selection error.
• "Не устроил срок доставки" - unacceptable delivery period.
• "Не возможно поставить продукт" - product delivery is impossible.
• "Автопродление" - auto-renewal.
• "Повторная оплата" - duplicated payment.
• "ChargeBack".
• "Недоволен программой" - unsatisfied with the program.
• "TYPO".
• "Дубли заказа" - duplicated order.
• "Тестовый заказ" - test order.

or any other issue.

(For orders in Softline Checkout) Order item sequential number. Sequential numbering of items remains for all events.
Format: "[item sequential number in order]-of-[total amount of items in order]".
E.g.: "1-of-2", if there are only two products in an order and a notification is sent for the first product.

(For payments in Softline Payments) "1-of-1" is always transferred.