Types of events

Currently, based on events subscribed for a webhook, we send the following types of events through webhooks. Keep in mind that additional types of events may be added in the future. Therefore, do not assume that these are the only types of events available when developing and maintaining your code.

The events follow a pattern: resource.event.

payment.created

Occurs whenever a payment is created.

{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": null,
"created": null,
"currency": "SATS",
"exchange_rate": 1,
"expires_at": null,
"id": "pi_xxxxxxxxxxxxxxxxxxxxx",
"metadata": {},
"modified": null,
"object": "payment",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": unpaid,
"target_amount": null,
"target_currency": null,
"ttl": null
}
},
"event_type": "payment.created",
"id": "evt_xxxxxxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {}
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_method_options": {
        "lightning": {
          "id": "lni_xxxxxxxxxxxxxx",
          "payment_request": "lntbxxxxxxxxxxxxxxxxxx"
        },
        "on_chain": {
          "address": null,
          "id": "btcaddr_xxxxxxxxxxxxxxxx"
        }
      },
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "statement_descriptor": null,
      "status": "unpaid",
      "target_amount": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.created",
  "id": "evt_xxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxx"
  }
}

payment.paid

Occurs whenever a payment is paid.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "statement_descriptor": null,
      "status": "paid",
      "target_amount": null,
      "target_amount_paid": null,
      "target_amount_paid_at": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.paid",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "confirmations": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_method_options": {
        "lightning": {
          "id": "lni_xxxxxxxxxxxxxx",
          "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        },
        "on_chain": {
          "address": null,
          "id": "btcaddr_xxxxxxxxxxxxxxxxxxx"
        }
      },
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "statement_descriptor": null,
      "status": "paid",
      "target_amount": null,
      "target_amount_paid": null,
      "target_amount_paid_at": null,
      "target_amount_paid_by": "lni_xxxxxxxxxxxxxxx",
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.paid",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": null,
  "request": {}
}

payment.expired

Occurs whenever a payment is expired.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "description": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "statement_descriptor": null,
      "status": "expired",
      "target_amount": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.expired",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_method_options": {
        "lightning": {
          "id": "lni_xxxxxxxxxxxxxx",
          "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        },
        "on_chain": {
          "address": null,
          "id": "btcaddr_xxxxxxxxxxx"
        }
      },
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "statement_descriptor": null,
      "status": "expired",
      "target_amount": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.expired",
  "id": "evt_xxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

payment.cancelled

Occurs whenever a payment is cancelled.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expire": null,
      "id": "pi_xxxxxxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "status": "cancelled",
      "target_amount": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.cancelled",
  "id": "evt_xxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "pi_xxxxxxxxxxxxxxxx",
      "metadata": {},
      "modified": null,
      "object": "payment",
      "payment_method_options": {
        "lightning": {
          "id": "lni_xxxxxxxxxxxxxxxxxx",
          "payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxx"
        }
      },
      "payment_methods": [
        "lightning"
      ],
      "statement_descriptor": null,
      "status": "cancelled",
      "target_amount": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "payment.cancelled",
  "id": "evt_xxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_session.created

Occurs whenever a checkout_session is created.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "cancel_url": null,
      "created": null,
      "currency": null,
      "default_url": null,
      "description": null,
      "id": "cs_xxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "statement_descriptor": null,
      "status": "active",
      "success_url": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.created",
  "id": "evt_xxxxxxxxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "default_url": null,
      "id": "cs_test_xxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "payments": [],
      "statement_descriptor": null,
      "status": "active",
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.created",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_session.paid

Occurs whenever a checkout_session is fully paid.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "default_url": null,
      "id": "cs_xxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "payment": {
        "created": null,
        "exchange_rate": null,
        "expires_at": null,
        "id": "pi_xxxxxxxxxxxxxxx",
        "modified": null,
        "statement_descriptor": null,
        "status": "paid",
        "ttl": null
      },
      "statement_descriptor": null,
      "status": "paid",
      "target_amount_paid": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.paid",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "amount_paid": null,
      "api_version": "2022-10-15",
      "created": null,
      "currency": null,
      "default_url": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "cs_xxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "payments": [
        {
          "amount_paid": null,
          "created": null,
          "exchange_rate": null,
          "id": "pi_xxxxxxxxxxx",
          "modified": null,
          "object": "payment",
          "target_amount_paid": null,
          "target_currency": null
        }
      ],
      "statement_descriptor": null,
      "status": "paid",
      "target_amount_paid": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.paid",
  "id": "evt_xxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_session.payment_paid

Occurs whenever any amount of payment is received for a checkout_session.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount_paid": null,
      "checkout_session_id": "cs_xxxxxxxxxxxxxxxx",
      "created": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "cspm_xxxxxxxxxxxxxxxxxxx",
      "modified": null,
      "payment_id": "pi_xxxxxxxxxxxxx",
      "payment_status": "PAID",
      "target_amount": null,
      "target_amount_paid": null,
      "target_currency": null
    }
  },
  "event_type": "checkout_session.payment_paid",
  "id": "evt_xxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount_paid": null,
      "checkout_session_id": null,
      "created": null,
      "exchange_rate": null,
      "expires_at": null,
      "id": "cspm_xxxxxxxxxxxxx",
      "modified": null,
      "payment_id": "pi_xxxxxxxxxxxxx",
      "payment_status": "PAID",
      "target_amount": null,
      "target_amount_paid": null,
      "target_currency": null
    }
  },
  "event_type": "checkout_session.payment_paid",
  "id": "evt_xxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_session.deactivated

Occurs whenever a checkout_session is deactivated.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "default_url": null,
      "id": "cs_xxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "status": "deactivated",
      "target_amount_paid": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.deactivated",
  "id": "evt_xxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "amount_paid": null,
      "created": null,
      "currency": null,
      "default_url": null,
      "id": "cs_xxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout_session",
      "payment_methods": [
        "onchain",
        "lightning"
      ],
      "payments": [],
      "statement_descriptor": null,
      "status": "deactivated",
      "target_amount_paid": null,
      "target_currency": null,
      "ttl": null
    }
  },
  "event_type": "checkout_session.deactivated",
  "id": "evt_xxxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_link.created

Occurs whenever a checkout_link is created.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "statement_descriptor": null,
      "status": "active",
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.created",
  "id": "evt_xxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "statement_descriptor": null,
      "status": "active",
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.created",
  "id": "evt_xxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

checkout_link.deactivated

Occurs whenever a checkout_link is deactivated.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "status": "deactivated",
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.deactivated",
  "id": "evt_xxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "payment_id": [],
      "statement_descriptor": null,
      "status": "deactivated",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.deactivated",
  "id": "evt_xxxxxxxxxxxx,\n  ",
  "livemode": "null",
  "object": "null",
  "events": "null ",
  "request": ": {}
}

checkout_link.paid

Occurs whenever a checkout_link is fully paid.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "payment_id": "pi_xxxxxxxxxxxxxx",
      "statement_descriptor": null,
      "status": "paid",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.paid",
  "id": "evt_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "clink_xxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "checkout.link",
      "payment_id": [
        "pi_xxxxxxxxxxxxx"
      ],
      "statement_descriptor": null,
      "status": "paid",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "checkout_link.paid",
  "id": "evt_xxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

payment_link.created

Occurs whenever a payment_link is created.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "statement_descriptor": null,
      "status": "active",
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.created",
  "id": "evt_xxxxxxxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "statement_descriptor": null,
      "status": "active",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.created",
  "id": "evt_xxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

payment_link.deactivated

Occurs whenever a payment_link is deactivated.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "statement_descriptor": null,
      "status": "deactivated",
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.deactivated",
  "id": "evt_xxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "+": "2022-10-15",
      "statement_descriptor": null,
      "status": "deactivated",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.deactivate",
  "id": "evt_xxxxxxxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}

payment_link.paymentreceived

Occurs whenever a full payment is received with a payment_link.

{
  "api_version": "2022-04-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "payment_id": "pi_xxxxxxxxxxxxxxxxx",
      "statement_descriptor": null,
      "status": "active",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.paymentreceived",
  "id": "evt_xxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
{
  "api_version": "2022-10-15",
  "data": {
    "object": {
      "amount": null,
      "created": null,
      "currency": null,
      "id": "plink_xxxxxxxxxxxxxxxxxxxxxx",
      "livemode": null,
      "metadata": {},
      "modified": null,
      "object": "payment.link",
      "payment_id": [
        "pi_xxxxxxxxxxxxxxxx"
      ],
      "statement_descriptor": null,
      "status": "active",
      "target_amount_paid": null,
      "target_currency": null,
      "url": null
    }
  },
  "event_type": "payment_link.paymentreceived",
  "id": "evt_xxxxxxxxxxxxxx",
  "livemode": null,
  "object": "events",
  "request": {}
}