Webhooks

Webhook notifications for shop events

Shop Order

Notification about a shop order payment completion.

Payload

application/json

namestring · enumRequiredExample: shop_orderPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "fee": 8000,
    "status": "paid",
    "email": "[email protected]",
    "isRecurrent": false,
    "period": "monthly"
  }
}

Shop Order Charge Failed

Notification when a recurring shop order charge fails. Sent after each failed charge attempt (up to 3 retries).

Payload

application/json

namestring · enumRequiredExample: shop_order_charge_failedPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order_charge_failed",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "period": "monthly",
    "chargeRetries": 1,
    "email": "[email protected]"
  }
}

Shop Order Charge Success

Notification when a recurring shop order is charged successfully.

Payload

application/json

namestring · enumRequiredExample: shop_order_charge_successPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order_charge_success",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "period": "monthly",
    "email": "[email protected]"
  }
}

Shop Order Cancelled

Notification when a recurring shop order subscription is cancelled.

Payload

application/json

namestring · enumRequiredExample: shop_order_cancelledPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order_cancelled",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "period": "monthly",
    "cancelReason": "cancelled_by_seller",
    "email": "[email protected]"
  }
}

Shop Order Refunded

Notification when a shop order transaction is refunded.

Payload

application/json

namestring · enumRequiredExample: shop_order_refundedPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order_refunded",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "transactionId": 12345,
    "amount": 100000,
    "currency": "rub",
    "status": "initiated",
    "refundedAt": "2025-03-20T01:15:58.33246Z"
  }
}

Shop Order Payment Failed

Notification when an initial shop order payment fails (e.g., card declined, insufficient funds). This is sent for one-time payments that fail during the initial payment attempt.

Payload

application/json

namestring · enumRequiredExample: shop_order_payment_failedPossible values:

created_atstring · date-timeRequired

Event creation time

Example: 2025-03-20T01:15:58.33246Z

sent_atstring · date-timeRequired

Event sending time

Example: 2025-03-20T01:15:58.542279448Z

Responses

200

Webhook successfully processed

application/json

400

Invalid webhook data

401

Invalid webhook signature

Payload

{
  "name": "shop_order_payment_failed",
  "created_at": "2025-03-20T01:15:58.33246Z",
  "sent_at": "2025-03-20T01:15:58.542279448Z",
  "payload": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 100000,
    "currency": "rub",
    "errorCode": "payment_declined",
    "errorMessage": "Card declined by issuer",
    "email": "[email protected]"
  }
}