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": 5000,
"created": 1696847071760,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696847671760,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696847071760,
"object": "payment",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "unpaid",
"target_amount": 5000,
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 600
}
},
"event_type": "payment.created",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 5000,
"created": 1696841375094,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696841975094,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696841375094,
"object": "payment",
"payment_method_options": {
"lightning": {
"id": "lni_xxxxxxxxxx",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"payment_methods": [
"lightning"
],
"status": "unpaid",
"target_amount": 5000,
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 600
}
},
"event_type": "payment.created",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
payment.paid
Occurs whenever a payment is paid.
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": 5000,
"created": 1696847071760,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696847671760,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696847331354,
"object": "payment",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "paid",
"target_amount": 5000,
"target_amount_paid": 5000,
"target_amount_paid_at": 1696847330000,
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 600
}
},
"event_type": "payment.paid",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 5000,
"confirmations": 1,
"created": 1696841899363,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696842499363,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696841944620,
"object": "payment",
"payment_method_options": {
"lightning": {
"id": "lni_xxxxxxxxxx",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxx"
}
},
"payment_methods": [
"lightning"
],
"status": "paid",
"target_amount": 5000,
"target_amount_paid": 5000,
"target_amount_paid_at": 1696841944000,
"target_amount_paid_by": "lni_xxxxxxxxxx",
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 600
}
},
"event_type": "payment.paid",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
payment.expired
Occurs whenever a payment is expired.
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": 5000,
"created": 1696847552407,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696847852407,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696847862766,
"object": "payment",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "expired",
"target_amount": 5000,
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300
}
},
"event_type": "payment.expired",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 5000,
"created": 1696841375094,
"currency": "SATS",
"description": "Payment V2",
"exchange_rate": 1,
"expires_at": 1696841975094,
"id": "pi_xxxxxxxxxx",
"metadata": {
"no": "1",
"type": "internal"
},
"modified": 1696841982809,
"object": "payment",
"payment_method_options": {
"lightning": {
"id": "lni_xxxxxxxxxx",
"payment_request": "lntbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"payment_methods": [
"lightning"
],
"status": "expired",
"target_amount": 5000,
"target_currency": "SATS",
"transfers": [
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"created_type": "SHARE",
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 600
}
},
"event_type": "payment.expired",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
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-10-15",
"data": {
"object": {
"amount": 100, //If you want your customer to make payment of a fixed amount, the value of amount should be greater than zero.
"type": "FIXED",
"amount_paid_tolerance": 5,
"created": 1696849159404,
"currency": "SATS",
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": false
},
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"modified": 1696849159404,
"object": "checkout_session",
"status": "active",
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.dev/pay/cs_test_xxxxxxxxxx"
}
},
"event_type": "checkout_session.created",
"id": "evt_xxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 0, //If you want the customer to choose any amount to pay, the value of the amount will always be zero.
"type": "FIXED",
"amount_paid_tolerance": 5,
"created": 1697453752890,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697453752890,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"statement_descriptor": "cancel url test",
"status": "active",
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.created",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 10, //If you’ve set the "type=options" you can offer your customers a selection of up to three payment amount options.
"type": "OPTIONS",
"amount_paid_tolerance": 5,
"created": 1697454262433,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697454262433,
"object": "checkout_session",
"options": [
10,
20,
30
],
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"statement_descriptor": "cancel url test",
"status": "active",
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.created",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 10, //If you’ve set the "type=preset" you can specify a minimum and maximum payment amount for your customers.
"type": "PRESET",
"amount_paid_tolerance": 5,
"created": 1697454075177,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697454075177,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"preset": {
"max_amount": 100,
"min_amount": 10
},
"statement_descriptor": "cancel url test",
"status": "active",
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.created",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": 100, //If you want your customer to make payment of a fixed amount, the value of amount should be greater than zero.
"cancel_url": null,
"created": null,
"currency": "SATS",
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxx",
"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"
}
}
checkout_session.paid
Occurs whenever a checkout_session is fully paid.
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 100,
"amount_paid": 100,
"api_version": "2022-10-15",
"created": null,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"exchange_rate": null,
"expires_at": null,
"id": "cs_xxxxxxxxxxxxxxx",
"livemode": null
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxxx"
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": false
},
"metadata": {},
"modified": null,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [
{
"amount_paid": 100,
"created": null,
"exchange_rate": null,
"id": "pi_xxxxxxxxxxx",
"modified": null,
"object": "payment",
"target_amount_paid": 100,
"target_currency": null
}
],
"statement_descriptor": null,
"status": "paid",
"target_amount_paid": 100,
"target_currency": null,
"ttl": null
}
},
"event_type": "checkout_session.paid",
"id": "evt_xxxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 0,
"amount_paid": 10,
"type": "FIXED",
"amount_paid_tolerance": 5,
"api_version": "2022-10-15",
"created": 1697453752890,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"exchange_rate": 1,
"expires_at": 1697519727401,
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections":
{
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxx",
"shipping_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
}
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697519463438,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [
{
"amount_paid": 10,
"created": 1697519427598,
"exchange_rate": 1,
"id": "pi_xxxxxxxxxxxx",
"modified": 1697519463370,
"object": "payment",
"target_amount_paid": 10,
"target_currency": "SATS"
}
],
"statement_descriptor": "cancel url test",
"status": "paid",
"target_amount_paid": 10,
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 10,
"amount_paid": 10,
"type": "OPTIONS",
"amount_paid_tolerance": 5,
"api_version": "2022-10-15",
"created": 1697454262433,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"exchange_rate": 1,
"expires_at": 1697456484712,
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxx",
"shipping_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
}
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697456221189,
"object": "checkout_session",
"options": [
10,
20,
30
],
"payment_methods": [
"onchain",
"lightning"
],
"payments": [
{
"amount_paid": 10,
"created": 1697456184812,
"exchange_rate": 1,
"id": "pi_xxxxxxxxxxxx",
"modified": 1697456221151,
"object": "payment",
"target_amount_paid": 10,
"target_currency": "SATS"
}
],
"statement_descriptor": "cancel url test",
"status": "paid",
"target_amount_paid": 10,
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 100,
"amount_paid": 100,
"type": "PRESET",
"amount_paid_tolerance": 5,
"api_version": "2022-10-15",
"created": 1697454075177,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.dev/pay/cs_test_xxxxxxxxxxxx",
"exchange_rate": 1,
"expires_at": 1697518096272,
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxx",
"shipping_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
}
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697517900474,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [
{
"amount_paid": 10,
"created": 1697456749436,
"exchange_rate": 1,
"id": "pi_xxxxxxxxxxxx",
"modified": 1697456781715,
"object": "payment",
"target_amount_paid": 10,
"target_currency": "SATS"
},
{
"amount_paid": 90,
"created": 1697517797619,
"exchange_rate": 1,
"id": "pi_xxxxxxxxxxxx",
"modified": 1697517900343,
"object": "payment",
"target_amount_paid": 90,
"target_currency": "SATS"
}
],
"preset": {
"max_amount": 100,
"min_amount": 10
},
"statement_descriptor": "cancel url test",
"status": "paid",
"target_amount_paid": 100,
"target_currency": "SATS",
"transfers": [
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
},
{
"description": "tr-1",
"destination_account": "acct_xxxxxxxxxxxx",
"percentage": 50
}
],
"ttl": 300,
"url": "https://checkout.tryspeed.dev/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": 100,
"created": null,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxxx",
"livemode": null,
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxx",
"shipping_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
}
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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": 100,
"target_currency": null,
"ttl": null
}
},
"event_type": "checkout_session.paid",
"id": "evt_xxxxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {
"id": "xxxxxxxxxxxxxxxx"
}
}
checkout_session.payment_paid
Occurs whenever any amount of payment is received for a checkout_session.
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount_paid": 100,
"checkout_session_id": "cs_xxxxxxxxxxxxxxxx",
"created": null,
"exchange_rate": null,
"expires_at": null,
"id": "cspm_xxxxxxxxxxxxx",
"modified": null,
"payment_id": "pi_xxxxxxxxxxxxx",
"payment_status": "PAID",
"target_amount": 100,
"target_amount_paid": 100,
"target_currency": null
}
},
"event_type": "checkout_session.payment_paid",
"id": "evt_xxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount_paid": 10,
"checkout_session_id": "cs_xxxxxxxxxxxxxxxx",
"created": 1697519427598,
"exchange_rate": 1,
"expires_at": 1697519727401,
"id": "cspm_xxxxxxxxxxxx",
"modified": 1697519463370,
"payment_id": "pi_xxxxxxxxxxxx",
"payment_status": "PAID",
"target_amount": 0,
"target_amount_paid": 10,
"target_currency": "SATS"
}
},
"event_type": "checkout_session.payment_paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount_paid": 10,
"checkout_session_id": "cs_xxxxxxxxxxxxxxxx",
"created": 1697456184812,
"exchange_rate": 1,
"expires_at": 1697456484712,
"id": "cspm_xxxxxxxxxxxx",
"modified": 1697456221151,
"payment_id": "pi_xxxxxxxxxxxx",
"payment_status": "PAID",
"target_amount": 10,
"target_amount_paid": 10,
"target_currency": "SATS"
}
},
"event_type": "checkout_session.payment_paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount_paid": 90,
"checkout_session_id": "cs_xxxxxxxxxxxxxxxx",
"created": 1697517797619,
"exchange_rate": 1,
"expires_at": 1697518096272,
"id": "cspm_xxxxxxxxxxxx",
"modified": 1697517900343,
"payment_id": "pi_xxxxxxxxxxxx",
"payment_status": "PAID",
"target_amount": 90,
"target_amount_paid": 90,
"target_currency": "SATS"
}
},
"event_type": "checkout_session.payment_paid",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount_paid": 100,
"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": 100,
"target_amount_paid": 100,
"target_currency": null
}
},
"event_type": "checkout_session.payment_paid",
"id": "evt_xxxxxxxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {
"id": "xxxxxxxxxxxxxxxxxxxxxxx"
}
}
checkout_session.deactivated
Occurs whenever a checkout_session is deactivated.
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 100,
"amount_paid": 100,
"created": null,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_xxxxxxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxx",
"livemode": null,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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": {}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 0,
"amount_paid": 0,
"type": "FIXED",
"amount_paid_tolerance": 5,
"created": 1697522745652,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_xxxxxxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697522754865,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"statement_descriptor": "cancel url test",
"status": "deactivated",
"target_amount_paid": 0,
"target_currency": "SATS",
"transfers": [],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.deactivated",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 10,
"amount_paid": 0,
"type": "OPTIONS",
"amount_paid_tolerance": 5,
"created": 1697522373512,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_xxxxxxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697522387565,
"object": "checkout_session",
"options": [
20,
30,
10
],
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"statement_descriptor": "cancel url test",
"status": "deactivated",
"target_amount_paid": 0,
"target_currency": "SATS",
"transfers": [],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.deactivated",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-10-15",
"data": {
"object": {
"amount": 10,
"amount_paid": 0,
"type": "PRESET",
"amount_paid_tolerance": 5,
"created": 1697522641186,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_xxxxxxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxx",
"livemode": false,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": 1697522656690,
"object": "checkout_session",
"payment_methods": [
"onchain",
"lightning"
],
"payments": [],
"preset": {
"max_amount": 100,
"min_amount": 10
},
"statement_descriptor": "cancel url test",
"status": "deactivated",
"target_amount_paid": 0,
"target_currency": "SATS",
"transfers": [],
"ttl": 300,
"url": "https://checkout.tryspeed.com/pay/cs_test_xxxxxxxxxxxx"
}
},
"event_type": "checkout_session.deactivated",
"id": "evt_xxxxxxxxxxxx",
"livemode": false,
"object": "events",
"request": {
"id": "xxxxxxxxxxxx"
}
}
{
"api_version": "2022-04-15",
"data": {
"object": {
"amount": 100,
"created": null,
"currency": "SATS",
"default_url": "https://checkout.tryspeed.com/pay/cs_xxxxxxxxxxxxxxxx",
"id": "cs_xxxxxxxxxxxxxxxxx",
"livemode": null,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"metadata": {},
"modified": null,
"object": "checkout_session",
"status": "deactivated",
"target_amount_paid": 100,
"target_currency": null,
"ttl": null
}
},
"event_type": "checkout_session.deactivated",
"id": "evt_xxxxxxxxxxxxxxxxx",
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": false
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": false
},
"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,
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxxx",
"shipping_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
}
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections": {
"billing_address": {
"city": "Lancaster",
"country": "Algeria",
"line1": "42212 10th Street West",
"name": "John Doe",
"postal_code": "93534",
"state": "California"
},
"email": "[email protected]",
"phone": "+1 xxxxxxxxxx"
},
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": false
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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,
"customer_collections_status": {
"is_billing_address_enabled": true,
"is_email_enabled": true,
"is_phone_enabled": true,
"is_shipping_address_enabled": true
},
"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": {}
}
invoice.paid
Occurs whenever an invoice is paid.
{
"api_version": "2022-04-15",
"data":{
"id": "in_ll3lrirptIEu2AmZ",
"object": "invoices",
"currency": "USD",
"customer_id": "cus_ll3lripxJiBWUAa9",
"description": "invoice description",
"hosted_invoice_url": "https://invoice.tryspeed.dev/pay/in_ll3lrirptIEu2AaB",
"status": "paid",
"invoice_number": "INV-000002",
"invoice_amount": 0.1,
"invoice_amount_paid": 0.1000393959439953,
"target_amount_paid": 336,
"target_currency": "SATS",
"invoice_due_date": 1694169839463,
"invoice_pdf": null,
"invoice_emails_cc": [],
"statement_descriptor": null,
"footer": "footer updated",
"memo": "Memo updated",
"created": 1691577829563,
"modified": 1691577911169
},
"event_type": "invoice.paid",
"id": "evt_xxxxxxxxxxxxxxxxx",
"livemode": null,
"object": "events",
"request": {}
}
Updated about 1 month ago