Skip to main content
WEBHOOK
payment_page.payment_received
{
  "id": "evt_2341234567890abcdef",
  "type": "payment_page.payment_received",
  "data": {
    "id": "pt_9N2a38DJQWPL8K4X",
    "payment_page_id": "pp_EVT9283NAKSD8234SKJD",
    "status": "succeeded",
    "amount": 15000,
    "currency": "KES",
    "customer": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "phone": "+254712345678"
    },
    "custom_fields": {
      "session_choice": "Morning (8AM–12PM)",
      "dietary_restrictions": "Vegan",
      "referral_code": "FITWELL100"
    },
    "products": [
      {
        "product_id": "product_123123",
        "qty": 2,
        "price": 7500,
        "currency": "KES",
        "description": "Wellness Workshop Ticket"
      },
      {
        "product_id": "product_654321",
        "qty": 1,
        "price": 0,
        "currency": "KES",
        "description": "Free Meditation Guide"
      }
    ],
    "delivery_address": {
      "line1": "123 Wellness Avenue",
      "line2": "Suite 5B",
      "city": "Nairobi",
      "state": "Nairobi County",
      "country": "KE",
      "pin": "00100"
    },
    "payment_id": "p_xyz789abc123def456",
    "checkout_session_id": "chk_456789abc123def",
    "metadata": {
      "event_id": "wellness_nairobi_2025"
    },
    "created_at": "2025-06-18T08:45:00Z",
    "updated_at": "2025-06-18T08:45:10Z"
  }
}

Body

application/json

Represents an occurrence in the system that triggers the webhook, containing an identifier, event type, and relevant data.

​
id
string
required

Unique identifier for a webhook event

Required string length: 24 - 50
Example:

"evt_1234567890abcdef"

​
type
enum<string>
required

Type of webhook event

Available options:
payment_page.payment_received
Example:

"payment_page.payment_received"

​
data
object
required

A transaction represents a completed or attempted payment through a payment page. Includes payment details, customer information, and custom field responses.

Response

200

Return a 200 status to indicate that the data was received successfully