Voltage Payments Webhooks

asyncapi: 3.0.0
info:
  title: Voltage Payments Webhooks
  version: 6.4.0
  description: >-
    AsyncAPI description of the Voltage Payments webhook event surface, generated by
    the API Evangelist enrichment pipeline from the public webhooks documentation
    (https://docs.voltageapi.com/webhooks). Voltage delivers events as HTTPS POST
    callbacks to a subscriber-registered URL. This spec models the documented event
    envelope and enums; it is a faithful generation, not a provider-published file.
  contact:
    name: Voltage
    url: https://docs.voltageapi.com/webhooks
  x-apievangelist-method: generated
  x-apievangelist-source: https://docs.voltageapi.com/webhooks
defaultContentType: application/json
servers:
  subscriber:
    host: your-domain.com
    protocol: https
    description: The subscriber HTTPS endpoint registered when creating a webhook.
channels:
  events:
    address: /
    description: Subscriber webhook endpoint that receives Voltage payment events.
    messages:
      sendEvent:
        $ref: '#/components/messages/SendEvent'
      receiveEvent:
        $ref: '#/components/messages/ReceiveEvent'
      testEvent:
        $ref: '#/components/messages/TestEvent'
operations:
  receiveEvents:
    action: receive
    channel:
      $ref: '#/channels/events'
    summary: Handle a payment webhook delivered by Voltage.
    messages:
    - $ref: '#/channels/events/messages/sendEvent'
    - $ref: '#/channels/events/messages/receiveEvent'
    - $ref: '#/channels/events/messages/testEvent'
components:
  messages:
    SendEvent:
      name: SendEvent
      title: Send payment event
      payload:
        type: object
        properties:
          type:
            type: string
            const: send
          detail:
            type: object
            properties:
              event:
                type: string
                enum: [succeeded, failed]
              data:
                type: object
    ReceiveEvent:
      name: ReceiveEvent
      title: Receive payment event
      payload:
        type: object
        properties:
          type:
            type: string
            const: receive
          detail:
            type: object
            properties:
              event:
                type: string
                enum: [generated, detected, refreshed, expired, succeeded, completed, failed]
              data:
                type: object
                properties:
                  status:
                    type: string
                    enum: [generating, receiving, expired, failed, completed]
    TestEvent:
      name: TestEvent
      title: Test event
      payload:
        type: object
        properties:
          type:
            type: string
            const: test
          detail:
            type: object
            properties:
              event:
                type: string
                enum: [created]
              data:
                type: object