CheckoutPublicSessionResponse

  • additionalAmount
    Type: integer
    required

    Integer numbers.

  • appearance
    Type: object
    required

    Snapshot imutável da personalização usada para renderizar o checkout. Em sessões antigas sem snapshot, o servidor devolve um padrão seguro (template STANDARD, nome de exibição genérico).

    • appearanceVersion
      enum
      const:  
      1
      required

      Integer numbers.

      values
      • 1
    • banners
      Type: array object[] …3
      required
    • displayName
      Type: string
      required
    • template
      Type: stringenum
      required
      values
      • STANDARD
      • BANNER_TOP
      • PRODUCT_SHOWCASE
      • MINIMAL
      • TRUST_CENTER
      • MARKETPLACE
      • PREMIUM
    • theme
      Type: stringenum
      required
      values
      • LIGHT
      • DARK
    • backgroundColor
      Type: string nullable

      Hex color in #RRGGBB.

    • logoUrl
      Type: stringFormat: uri nullable
    • primaryColor
      Type: string nullable

      Hex color in #RRGGBB.

  • cancelUrl
    Type: string nullable
    required
  • coupon
    Type: object nullable
    required
    • appliedAmount
      Type: integer

      Integer numbers.

    • code
      Type: string
    • discountType
      Type: string
  • discountAmount
    Type: integer
    required

    Integer numbers.

  • expiresAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • lineItems
    Type: array object[] · CheckoutPublicSessionLineItem[]
    required
    • currency
      Type: string
      required
    • quantity
      Type: integer
      required

      Integer numbers.

    • snapshotProductName
      Type: string
      required
    • sortOrder
      Type: integer
      required

      Integer numbers.

    • unitAmount
      Type: integer
      required

      Integer numbers.

    • productId
      Type: string nullable

      ID do produto exibido na aba Produtos do Checkout.

    • snapshotImageUrl
      Type: stringFormat: uri nullable

      URL HTTPS da imagem do produto capturada na criação da sessão a partir do catálogo. Não é aceita de input livre.

  • sessionId
    Type: string
    required
  • shippingAmount
    Type: integer
    required

    Integer numbers.

  • status
    Type: string
    required

    Estado da sessão (ex.: PENDING, PIX_CREATED, PAID, EXPIRED, CANCELLED).

  • subtotalAmount
    Type: integer
    required

    Centavos

  • successUrl
    Type: string nullable
    required
  • totalAmount
    Type: integer
    required

    Integer numbers.