WebhookPayload

  • data
    required

    Event-specific data. Structure depends on the event type (discriminated by type).

    • type
      Discriminator
      Type: string
      required

      Event type

    • amount
      Type: string Pattern: ^\d+\.\d{8}$
      required

      Payment amount as a decimal string with eight decimal places

    • currency
      Type: string
      required

      Three-letter ISO 4217 currency code

    • customerId
      Type: string
      required

      Customer identifier from your system

    • id
      Type: stringFormat: uuid
      required

      Payment intent identifier

    • merchantId
      Type: stringFormat: uuid
      required

      Associated merchant ID

    • merchantReference
      Type: string
      required

      Your order/transaction reference

    • paymentMethodId
      Type: string
      required

      Payment method identifier

    • status
      Type: stringenum
      required

      Status of the payment intent. Matches the second segment of type (e.g. succeeded for payment_intent.succeeded).

      values
      • initiated
      • requires_action
      • processing
      • succeeded
      • failed
      • canceled
    • action
      nullable

      Redirect the customer to url to complete payment with the provider. Used by neteller-paysafe, paysafecard-trustpayments, card-rillpay, and openbanking-rillpay.

      • expiresAt
        Type: stringFormat: date-time
        required

        Timestamp after which the redirect URL is no longer valid

      • method
        Type: stringenum
        required

        HTTP method to use when redirecting

        values
        • GET
        • POST
      • type
        enum
        const:  
        redirect
        required
        values
        • redirect
      • url
        Type: stringFormat: uri
        required

        Absolute URL to redirect the customer to

    • paymentId
      Type: stringFormat: uuid nullable

      Associated payment ID (null until payment is created)

  • id
    Type: stringFormat: uuid
    required

    Unique webhook notification identifier (use for idempotency)

  • occurredAt
    Type: stringFormat: date-time
    required

    ISO 8601 timestamp with milliseconds when the event occurred

  • type
    Type: stringenum
    required

    Event type that determines the structure of the data field

    values
    • payment_intent.initiated
    • payment_intent.requires_action
    • payment_intent.processing
    • payment_intent.succeeded
    • payment_intent.canceled
  • version
    Type: string
    required

    API version used for this webhook payload