{
"eventId": "evt_3c4d5e6f-7g8h-9i0j-1k2l-3m4n5o6p7q8r",
"eventType": "payment.succeeded",
"timestamp": "2024-12-16T10:30:15Z",
"data": {
"payment": {
"id": "2e3b4f5a-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
"amount": "125.50",
"currency": "USD",
"source": {
"object": "card",
"name": "Jane Doe",
"number": "************4242",
"expMonth": 12,
"expYear": 2025,
"brand": "VISA",
"addressCountry": "us",
"addressPostCode": "10001"
},
"status": "SUCCEEDED",
"createdAt": "2024-12-16T10:30:00Z"
},
"order": {
"id": "019b4139-1234-7abc-8def-123456789abc",
"petId": "019b4132-70aa-764f-b315-e2803d882a24",
"userId": "019b4138-e0af-70b9-8f0c-6ea97d495dfa",
"status": "APPROVED",
"totalAmount": "125.50",
"currency": "USD",
"createdAt": "2024-12-16T09:00:00Z",
"updatedAt": "2024-12-16T10:30:15Z"
},
"receipt": {
"receiptId": "rcp_4d5e6f7g-8h9i-0j1k-2l3m-4n5o6p7q8r9s",
"receiptUrl": "https://api.petstoreapi.com/v1/receipts/rcp_4d5e6f7g-8h9i-0j1k-2l3m-4n5o6p7q8r9s",
"generatedAt": "2024-12-16T10:30:15Z"
}
}
}Webhooks
Payment succeeded event
Triggered when a payment is successfully processed and confirmed. This webhook notifies your system of successful payment transactions, enabling real-time updates for order fulfillment, customer notifications, and accounting workflows.
Payment Processing
When a payment succeeds:
- Payment status changes to
SUCCEEDED - Order status typically updates to
APPROVED - Payment receipt is generated
- Funds are confirmed and captured
Webhook Security
All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.
WEBHOOK
paymentSucceeded
{
"eventId": "evt_3c4d5e6f-7g8h-9i0j-1k2l-3m4n5o6p7q8r",
"eventType": "payment.succeeded",
"timestamp": "2024-12-16T10:30:15Z",
"data": {
"payment": {
"id": "2e3b4f5a-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
"amount": "125.50",
"currency": "USD",
"source": {
"object": "card",
"name": "Jane Doe",
"number": "************4242",
"expMonth": 12,
"expYear": 2025,
"brand": "VISA",
"addressCountry": "us",
"addressPostCode": "10001"
},
"status": "SUCCEEDED",
"createdAt": "2024-12-16T10:30:00Z"
},
"order": {
"id": "019b4139-1234-7abc-8def-123456789abc",
"petId": "019b4132-70aa-764f-b315-e2803d882a24",
"userId": "019b4138-e0af-70b9-8f0c-6ea97d495dfa",
"status": "APPROVED",
"totalAmount": "125.50",
"currency": "USD",
"createdAt": "2024-12-16T09:00:00Z",
"updatedAt": "2024-12-16T10:30:15Z"
},
"receipt": {
"receiptId": "rcp_4d5e6f7g-8h9i-0j1k-2l3m-4n5o6p7q8r9s",
"receiptUrl": "https://api.petstoreapi.com/v1/receipts/rcp_4d5e6f7g-8h9i-0j1k-2l3m-4n5o6p7q8r9s",
"generatedAt": "2024-12-16T10:30:15Z"
}
}
}Authorizations
bearerAuthoauth2
Bearer token authentication using JWT (JSON Web Token). Include the token in the Authorization header as: Authorization: Bearer <token>
Body
application/json
Response
Webhook received successfully