{
"api_version": "v1",
"api_version_date": null,
"company_id": "biz_xxxxxxxxxxxxxx",
"data": {
"amount_after_fees": 6.9,
"application_fee": {
"amount": 6.9,
"amount_captured": 6.9,
"amount_refunded": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "apfee_xxxxxxxxxxxx"
},
"auto_refunded": true,
"billing_address": {
"city": "some_string",
"country": "some_string",
"line1": "some_string",
"line2": "some_string",
"name": "some_string",
"postal_code": "some_string",
"state": "some_string"
},
"billing_reason": "subscription_create",
"card_brand": "mastercard",
"card_exp_month": 6,
"card_exp_year": 2027,
"card_last4": "4242",
"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
"company": {
"id": "biz_xxxxxxxxxxxxxx",
"route": "some_string",
"title": "some_string"
},
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"customer_phone": "some_string",
"decline_code": "insufficient_funds",
"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
"disputes": [
{
"amount": 6.9,
"currency": "usd",
"editable": true,
"id": "dspt_xxxxxxxxxxxxx",
"needs_response_by": "2023-12-01T05:00:00.401Z",
"notes": "Customer used the product for 3 months before disputing.",
"reason": "Product Not Received",
"status": "warning_needs_response"
},
{
"amount": 6.9,
"currency": "usd",
"editable": true,
"id": "dspt_xxxxxxxxxxxxx",
"needs_response_by": "2023-12-01T05:00:00.401Z",
"notes": "Customer used the product for 3 months before disputing.",
"reason": "Product Not Received",
"status": "warning_needs_response"
}
],
"failure_message": "some_string",
"financing_installments_count": 42,
"financing_transactions": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "ptx_xxxxxxxxxxxxxx",
"status": "succeeded",
"transaction_type": "purchase"
},
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "ptx_xxxxxxxxxxxxxx",
"status": "succeeded",
"transaction_type": "purchase"
}
],
"id": "pay_xxxxxxxxxxxxxx",
"last_payment_attempt": "2023-12-01T05:00:00.401Z",
"member": {
"id": "some_string",
"phone": "some_string"
},
"membership": {
"id": "mem_xxxxxxxxxxxxxx",
"phone_number": "some_string",
"status": "trialing"
},
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"needs_tracking": true,
"next_payment_attempt": "2023-12-01T05:00:00.401Z",
"paid_at": "2023-12-01T05:00:00.401Z",
"payment_method": {
"card": {
"brand": "mastercard",
"exp_month": 42,
"exp_year": 42,
"last4": "4242"
},
"created_at": "2023-12-01T05:00:00.401Z",
"id": "payt_xxxxxxxxxxxxx",
"payment_method_type": "acss_debit"
},
"payment_method_type": "acss_debit",
"payments_failed": 42,
"plan": {
"id": "plan_xxxxxxxxxxxxx",
"internal_notes": "some_string",
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
}
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"route": "pickaxe-analytics",
"title": "Pickaxe Analytics"
},
"promo_code": {
"amount_off": 6.9,
"base_currency": "usd",
"code": "some_string",
"id": "promo_xxxxxxxxxxxx",
"number_of_intervals": 42,
"promo_type": "percentage"
},
"refundable": true,
"refunded_amount": 6.9,
"refunded_at": "2023-12-01T05:00:00.401Z",
"refunds": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "rf_xxxxxxxxxxxxxxx",
"status": "pending"
},
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "rf_xxxxxxxxxxxxxxx",
"status": "pending"
}
],
"resolutions": [
{
"customer_appealed": true,
"customer_response_actions": [
"respond",
"respond"
],
"due_date": "2023-12-01T05:00:00.401Z",
"id": "reso_xxxxxxxxxxxxx",
"issue": "forgot_to_cancel",
"merchant_appealed": true,
"merchant_response_actions": [
"accept",
"accept"
],
"platform_response_actions": [
"request_buyer_info",
"request_buyer_info"
],
"status": "merchant_response_needed"
},
{
"customer_appealed": true,
"customer_response_actions": [
"respond",
"respond"
],
"due_date": "2023-12-01T05:00:00.401Z",
"id": "reso_xxxxxxxxxxxxx",
"issue": "forgot_to_cancel",
"merchant_appealed": true,
"merchant_response_actions": [
"accept",
"accept"
],
"platform_response_actions": [
"request_buyer_info",
"request_buyer_info"
],
"status": "merchant_response_needed"
}
],
"retryable": true,
"risk_score": 42,
"risk_signals": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"settlement_amount": 6.9,
"settlement_currency": "usd",
"settlement_exchange_rate": 6.9,
"settlement_time_at": "2023-12-01T05:00:00.401Z",
"shipment": {
"carrier": "usps",
"id": "ship_xxxxxxxxxxxxx",
"status": "unknown",
"tracking_number": "9400111899223456789012",
"tracking_url": "https://track.aftership.com/9400111899223456789012"
},
"shipping_address": {
"city": "some_string",
"country": "some_string",
"line1": "some_string",
"line2": "some_string",
"name": "some_string",
"postal_code": "some_string",
"state": "some_string"
},
"status": "draft",
"substatus": "succeeded",
"subtotal": 6.9,
"tax_amount": 6.9,
"tax_behavior": "exclusive",
"tax_refunded_amount": 6.9,
"three_ds_verified": true,
"total": 6.9,
"updated_at": "2023-12-01T05:00:00.401Z",
"usd_total": 6.9,
"user": {
"email": "john.doe@example.com",
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
},
"voidable": true
},
"id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
"timestamp": "2025-01-01T00:00:00.000Z",
"type": "payment.failed"
}Payment failed
Sent when a payment is failed
Required permissions:
payment:basic:readplan:basic:readaccess_pass:basic:readmember:email:readmember:basic:readmember:phone:readpromo_code:basic:readshipment:basic:readpayment:dispute:readpayment:resolution_center_case:readwebhook_receive:payments
{
"api_version": "v1",
"api_version_date": null,
"company_id": "biz_xxxxxxxxxxxxxx",
"data": {
"amount_after_fees": 6.9,
"application_fee": {
"amount": 6.9,
"amount_captured": 6.9,
"amount_refunded": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "apfee_xxxxxxxxxxxx"
},
"auto_refunded": true,
"billing_address": {
"city": "some_string",
"country": "some_string",
"line1": "some_string",
"line2": "some_string",
"name": "some_string",
"postal_code": "some_string",
"state": "some_string"
},
"billing_reason": "subscription_create",
"card_brand": "mastercard",
"card_exp_month": 6,
"card_exp_year": 2027,
"card_last4": "4242",
"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
"company": {
"id": "biz_xxxxxxxxxxxxxx",
"route": "some_string",
"title": "some_string"
},
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"customer_phone": "some_string",
"decline_code": "insufficient_funds",
"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
"disputes": [
{
"amount": 6.9,
"currency": "usd",
"editable": true,
"id": "dspt_xxxxxxxxxxxxx",
"needs_response_by": "2023-12-01T05:00:00.401Z",
"notes": "Customer used the product for 3 months before disputing.",
"reason": "Product Not Received",
"status": "warning_needs_response"
},
{
"amount": 6.9,
"currency": "usd",
"editable": true,
"id": "dspt_xxxxxxxxxxxxx",
"needs_response_by": "2023-12-01T05:00:00.401Z",
"notes": "Customer used the product for 3 months before disputing.",
"reason": "Product Not Received",
"status": "warning_needs_response"
}
],
"failure_message": "some_string",
"financing_installments_count": 42,
"financing_transactions": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "ptx_xxxxxxxxxxxxxx",
"status": "succeeded",
"transaction_type": "purchase"
},
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "ptx_xxxxxxxxxxxxxx",
"status": "succeeded",
"transaction_type": "purchase"
}
],
"id": "pay_xxxxxxxxxxxxxx",
"last_payment_attempt": "2023-12-01T05:00:00.401Z",
"member": {
"id": "some_string",
"phone": "some_string"
},
"membership": {
"id": "mem_xxxxxxxxxxxxxx",
"phone_number": "some_string",
"status": "trialing"
},
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"needs_tracking": true,
"next_payment_attempt": "2023-12-01T05:00:00.401Z",
"paid_at": "2023-12-01T05:00:00.401Z",
"payment_method": {
"card": {
"brand": "mastercard",
"exp_month": 42,
"exp_year": 42,
"last4": "4242"
},
"created_at": "2023-12-01T05:00:00.401Z",
"id": "payt_xxxxxxxxxxxxx",
"payment_method_type": "acss_debit"
},
"payment_method_type": "acss_debit",
"payments_failed": 42,
"plan": {
"id": "plan_xxxxxxxxxxxxx",
"internal_notes": "some_string",
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
}
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"metadata": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"route": "pickaxe-analytics",
"title": "Pickaxe Analytics"
},
"promo_code": {
"amount_off": 6.9,
"base_currency": "usd",
"code": "some_string",
"id": "promo_xxxxxxxxxxxx",
"number_of_intervals": 42,
"promo_type": "percentage"
},
"refundable": true,
"refunded_amount": 6.9,
"refunded_at": "2023-12-01T05:00:00.401Z",
"refunds": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "rf_xxxxxxxxxxxxxxx",
"status": "pending"
},
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "usd",
"id": "rf_xxxxxxxxxxxxxxx",
"status": "pending"
}
],
"resolutions": [
{
"customer_appealed": true,
"customer_response_actions": [
"respond",
"respond"
],
"due_date": "2023-12-01T05:00:00.401Z",
"id": "reso_xxxxxxxxxxxxx",
"issue": "forgot_to_cancel",
"merchant_appealed": true,
"merchant_response_actions": [
"accept",
"accept"
],
"platform_response_actions": [
"request_buyer_info",
"request_buyer_info"
],
"status": "merchant_response_needed"
},
{
"customer_appealed": true,
"customer_response_actions": [
"respond",
"respond"
],
"due_date": "2023-12-01T05:00:00.401Z",
"id": "reso_xxxxxxxxxxxxx",
"issue": "forgot_to_cancel",
"merchant_appealed": true,
"merchant_response_actions": [
"accept",
"accept"
],
"platform_response_actions": [
"request_buyer_info",
"request_buyer_info"
],
"status": "merchant_response_needed"
}
],
"retryable": true,
"risk_score": 42,
"risk_signals": {
"boolean": true,
"camelCase": "also_ok",
"nested": {
"okCamel": true,
"ok_snake": "ok"
},
"number": 1,
"snake_case": "ok"
},
"settlement_amount": 6.9,
"settlement_currency": "usd",
"settlement_exchange_rate": 6.9,
"settlement_time_at": "2023-12-01T05:00:00.401Z",
"shipment": {
"carrier": "usps",
"id": "ship_xxxxxxxxxxxxx",
"status": "unknown",
"tracking_number": "9400111899223456789012",
"tracking_url": "https://track.aftership.com/9400111899223456789012"
},
"shipping_address": {
"city": "some_string",
"country": "some_string",
"line1": "some_string",
"line2": "some_string",
"name": "some_string",
"postal_code": "some_string",
"state": "some_string"
},
"status": "draft",
"substatus": "succeeded",
"subtotal": 6.9,
"tax_amount": 6.9,
"tax_behavior": "exclusive",
"tax_refunded_amount": 6.9,
"three_ds_verified": true,
"total": 6.9,
"updated_at": "2023-12-01T05:00:00.401Z",
"usd_total": 6.9,
"user": {
"email": "john.doe@example.com",
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
},
"voidable": true
},
"id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
"timestamp": "2025-01-01T00:00:00.000Z",
"type": "payment.failed"
}Headers
A unique identifier for this webhook request
"msg_xxxxxxxxxxxxxxxxxxxxxxxx"
The signature of the webhook request with the webhook version prepended
"v1,BASE64ENCODEDSIGNATURE"
The timestamp in seconds since the Unix epoch that the webhook was sent at on the server
"1727606400"
Body
The API version for this webhook
"v1""v1"
The dated API version (Api-Version-Date) the payload is serialized to
"2026-07-20"
A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.
Show child attributes
Show child attributes
A unique ID for every single webhook request
"msg_xxxxxxxxxxxxxxxxxxxxxxxx"
The timestamp in ISO 8601 format that the webhook was sent at on the server
"2025-01-01T00:00:00.000Z"
The webhook event type
"payment.failed""payment.failed"
The account ID that this webhook event is associated with
"biz_xxxxxxxxxxxxxx"
Response
Return a 200 status to indicate that the data was received successfully

