PaymentIntent

  • action
    nullable
    required

    Next action required from the customer. null when the intent has transitioned to a terminal state (succeeded, failed, canceled) or is still in initiated. Discriminated by the type field.

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

    • type
      Discriminator
      enum
      const:  
      redirect
      required
      values
      • redirect
    • 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
    • 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 status is canceled

  • createdAt
    Type: stringFormat: date-time
    required

    Timestamp when the payment intent was created

  • currency
    Type: string
    required

    Three-letter ISO 4217 currency code

  • expiresAt
    Type: stringFormat: date-time nullable
    required

    Timestamp when the intent should expire, when known

  • id
    Type: stringFormat: uuid
    required

    Unique identifier for the payment intent

  • latestFailure
    Type: object nullable
    required

    Latest failure details when status is failed

    • propertyName
      Type: anything
  • merchantCustomerId
    Type: string
    required

    Your customer identifier provided when creating the intent

  • merchantId
    Type: stringFormat: uuid
    required

    Your merchant account identifier

  • merchantReference
    Type: string
    required

    Your unique order or transaction reference provided when creating the intent

  • paymentId
    Type: stringFormat: uuid nullable
    required

    Identifier of the associated payment. Null until a payment is created for this intent.

  • paymentMethodId
    Type: string
    required

    Payment method identifier in "method-provider" format

  • providerReference
    Type: string nullable
    required

    Reference assigned by the payment provider. Null until the provider returns a reference.

  • status
    Type: stringenum
    required

    Current lifecycle status of the payment intent:

    • initiated - intent created, no customer action available yet
    • requires_action - customer needs to complete an action (redirect or pay via requisites)
    • processing - payment is being processed by the provider
    • succeeded - payment is confirmed complete
    • failed - intent failed (e.g. provider error, customer rejection)
    • canceled - intent was canceled or expired without payment
    values
    • initiated
    • requires_action
    • processing
    • succeeded
    • failed
    • canceled