> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base39.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter os dados da página de pagamento Base39



## OpenAPI

````yaml /api-reference/openapi.json get /v2/billing/payment-page/{invoiceId}
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/billing/payment-page/{invoiceId}:
    get:
      tags:
        - billing
      summary: Obter os dados da página de pagamento Base39
      operationId: billing_get_payment_page
      parameters:
        - name: invoiceId
          required: true
          in: path
          description: ID opaco da fatura
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentPageOutput'
        '404':
          description: ''
components:
  schemas:
    PaymentPageOutput:
      type: object
      properties:
        id:
          type: string
          example: in_123
        number:
          type: string
          nullable: true
          example: INV-0001
        status:
          type: string
          enum:
            - open
            - overdue
            - paid
            - void
            - uncollectible
        amount:
          type: number
          description: Valor em centavos
          example: 450000
        currency:
          type: string
          example: BRL
        dueDate:
          type: string
          format: date-time
          nullable: true
        periodStart:
          type: string
          format: date-time
          nullable: true
        periodEnd:
          type: string
          format: date-time
          nullable: true
        description:
          type: string
          nullable: true
        lateFee:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PaymentPageChargeOutput'
        monthlyInterest:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PaymentPageChargeOutput'
        recipientName:
          type: string
          example: Base39
        payer:
          $ref: '#/components/schemas/PaymentPagePayerOutput'
        paymentMethods:
          type: array
          items:
            $ref: '#/components/schemas/BillingPaymentMethodOutput'
        fiscalDocuments:
          $ref: '#/components/schemas/PaymentPageFiscalDocumentsOutput'
        checkout:
          $ref: '#/components/schemas/PaymentPageCheckoutOutput'
      required:
        - id
        - number
        - status
        - amount
        - currency
        - dueDate
        - periodStart
        - periodEnd
        - description
        - lateFee
        - monthlyInterest
        - recipientName
        - payer
        - paymentMethods
        - fiscalDocuments
    PaymentPageChargeOutput:
      type: object
      properties:
        type:
          type: string
          enum:
            - fixed
            - percentage
        value:
          type: number
          description: Centavos quando fixed; pontos percentuais quando percentage
          example: 2
      required:
        - type
        - value
    PaymentPagePayerOutput:
      type: object
      properties:
        name:
          type: string
          example: ACME LTDA
        document:
          type: string
          example: 12.***.***/****-34
      required:
        - name
    BillingPaymentMethodOutput:
      type: object
      properties:
        type:
          type: string
          enum:
            - pix
            - boleto
        status:
          type: string
          enum:
            - ready
            - requires_action
            - unavailable
        value:
          type: string
          description: Pix copia e cola ou linha digitável do boleto
        pdfUrl:
          type: string
          description: URL do PDF do boleto
        unavailableReason:
          type: string
          description: Motivo pelo qual o método não está disponível
      required:
        - type
        - status
    PaymentPageFiscalDocumentsOutput:
      type: object
      properties:
        pdfUrl:
          type: string
          description: URL autenticada para baixar o PDF da nota fiscal persistida
        xmlUrl:
          type: string
          description: URL autenticada para baixar o XML da nota fiscal persistida
    PaymentPageCheckoutOutput:
      type: object
      properties:
        publishableKey:
          type: string
        clientSecret:
          type: string
      required:
        - publishableKey
        - clientSecret
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````