CheckoutSession

  • checkoutLink
    Type: stringFormat: uri
    required

    Redirect the customer here to continue the hosted checkout flow.

  • createdAt
    Type: stringFormat: date-time
    required

    Session creation time

  • expiresAt
    Type: stringFormat: date-time
    required

    Checkout collection expiry time

  • id
    Type: stringFormat: uuid
    required

    Checkout session identifier

  • paymentIntentId
    Type: stringFormat: uuid nullable
    required

    Underlying payment intent ID. Null until checkout creates or attaches the intent.

  • paymentMethod
    Type: object ยท CheckoutSessionPaymentMethod
    required
    • id
      Type: string
      required

      Payment method ID used by the checkout session

  • reference
    Type: string
    required

    Merchant order reference from the create request

  • status
    Type: stringenum
    required

    Checkout session state. Payment outcome is reported by the payment intent and payment webhooks.

    values
    • open
    • payment_pending
    • completed
    • failed
    • expired