> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vestrapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkout events (SSE)

> Server-Sent Events for the pay page. Not wrapped in { status, data }. Events include checkout.connected, checkout.heartbeat, checkout.awaiting_transfer, checkout.3ds_required, checkout.completed.




## OpenAPI

````yaml /openapi.yaml get /payment/checkout/events
openapi: 3.1.0
info:
  title: Vestrapay Payments API
  version: '1.0'
  description: >
    Initialize payments, collect card or bank transfer at checkout, and verify
    transactions. Amounts are major units as strings (100 naira is "100.00").
    Successful HTTP JSON is always `{ "status": "success", "data": … }`.
    Failures are `{ "status": "failed", "error", "message" }`. Webhook bodies
    are `{ "event", "data", "timestamp" }` and are not wrapped.
servers:
  - url: https://server.staging.vestrapay.app/v1
    description: Staging
  - url: https://api.vestrapay.com/v1
    description: Production
security:
  - SecretKey: []
tags:
  - name: Payments
    description: Server-to-server initialize and verify
  - name: Checkout
    description: Customer checkout session (access code)
paths:
  /payment/checkout/events:
    get:
      tags:
        - Checkout
      summary: Checkout events (SSE)
      description: >
        Server-Sent Events for the pay page. Not wrapped in { status, data }.
        Events include checkout.connected, checkout.heartbeat,
        checkout.awaiting_transfer, checkout.3ds_required, checkout.completed.
      operationId: checkout-events
      responses:
        '200':
          description: text/event-stream
      security:
        - AccessCode: []
components:
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Secret key (sk_test_ or sk_live_). Authorization Bearer with the same
        value is also accepted.
    AccessCode:
      type: apiKey
      in: header
      name: x-access-code
      description: Access code from initialize. Query access_code is also accepted.

````