PaymentIntentEventData

  • action
    nullable
    required

    Next action required from the customer. Only populated on payment_intent.requires_action; null for all other intent events.

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

    • 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

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

    Payment amount as a fixed-precision decimal string

  • cancellationReason
    Type: string nullable
    required

    Reason when the intent is canceled

  • currency
    Type: string
    required

    Three-letter ISO 4217 currency code

  • id
    Type: stringFormat: uuid
    required

    Payment intent identifier

  • latestFailure
    Type: object nullable
    required

    Latest failure details when the intent fails

    • propertyName
      Type: anything
  • merchantCustomerId
    Type: string
    required

    Customer identifier from your system

  • merchantId
    Type: stringFormat: uuid
    required

    Associated merchant ID

  • merchantReference
    Type: string
    required

    Your order/transaction reference

  • paymentId
    Type: stringFormat: uuid nullable
    required

    Associated payment ID (null until payment is created)

  • 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
  • type
    Type: string
    required

    Event type