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

# Get debt info for payment page (public)



## OpenAPI

````yaml /openapi.json get /api/v1/pix/debt/{debtId}/info
openapi: 3.0.0
info:
  title: Payable API
  description: >-
    REST API for integrating with Payable programmatically. Authenticate with
    Clerk JWT (web app) or API keys (`esk_live_` / `esk_test_`). Test keys
    operate in sandbox mode without wallet charges or real WhatsApp. Request
    bodies and query parameters are documented from class-validator /
    class-transformer DTOs. Every error is RFC 9457 `application/problem+json`;
    branch on `code`, not `detail`.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.payable.run
    description: Production
  - url: https://localhost:3000
    description: Local
security: []
tags: []
paths:
  /api/v1/pix/debt/{debtId}/info:
    get:
      tags:
        - payments
      summary: Get debt info for payment page (public)
      operationId: PixController_getDebtInfo[0]
      parameters:
        - name: debtId
          required: true
          in: path
          schema:
            type: string
        - name: token
          required: true
          in: query
          schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDebtInfoResponseDto'
        '404':
          description: Debt not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: RFC 9457 problem details. Inspect `code` for programmatic handling.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PublicDebtInfoResponseDto:
      type: object
      properties:
        sandbox:
          type: boolean
          description: >-
            Test (sandbox) debt: the page shows only the sample PIX and the
            "Simular pagamento" button (`POST
            /pix/debt/:debtId/simulate-payment`); nothing is charged
        debtorName:
          type: string
          example: João S.
        creditorName:
          type: string
        amountFormatted:
          type: string
          example: R$ 150,00
        amount:
          type: string
          example: '150.00'
        originalAmount:
          type: object
        discountPercentage:
          type: number
        hasCollectionOffer:
          type: boolean
        maxCardInstallments:
          type: number
        description:
          type: string
        dueDate:
          type: string
        methods:
          description: >-
            Methods actually available for this debt (GW-20) — the frontend
            builds its checkout tabs from this, not from a hardcoded provider.
          type: array
          items:
            $ref: '#/components/schemas/PublicCheckoutMethodDto'
        boletoMissingPayerData:
          type: array
          description: >-
            Payer fields the boleto needs that the client record lacks; the
            checkout asks the debtor for them and sends them to
            generate-for-debt. Empty when nothing is missing or boleto is not
            offered.
          items:
            type: string
            enum:
              - document
              - zipCode
              - street
              - streetNumber
              - neighborhood
              - city
              - state
        mpPublicKey:
          type: object
          nullable: true
          deprecated: true
        mpCheckoutEnabled:
          type: boolean
          deprecated: true
        custody:
          type: boolean
          description: >-
            PIX is received by Payable on the creditor's behalf and paid out to
            them (no own PIX gateway)
        collectionMode:
          type: string
          enum:
            - billing
            - recovery
          description: >-
            Cobrança (`billing`) ou Recuperação (`recovery`); a página mostra
            "Não reconheço esta dívida" só na Recuperação
        disputeOpen:
          type: boolean
          description: >-
            Contestação aberta pelo cliente (`recoveryStatus = disputed`),
            aguardando a empresa
        disputeVoided:
          type: boolean
          description: >-
            A empresa confirmou que a cobrança é indevida (`recoveryStatus =
            voided`); a página não oferece mais a contestação
      required:
        - sandbox
        - debtorName
        - creditorName
        - amountFormatted
        - amount
        - originalAmount
        - discountPercentage
        - hasCollectionOffer
        - maxCardInstallments
        - description
        - dueDate
        - methods
        - boletoMissingPayerData
        - mpCheckoutEnabled
        - custody
        - collectionMode
        - disputeOpen
        - disputeVoided
    ProblemDetails:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
          example: https://docs.payable.run/errors/validation_error
        title:
          type: string
          example: Bad Request
        status:
          type: integer
          example: 400
        detail:
          type: string
          example: One or more request fields are invalid.
        instance:
          type: string
          example: /api/v1/clients
        code:
          type: string
          example: VALIDATION_ERROR
        requestId:
          type: string
          format: uuid
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              field:
                type: string
              message:
                type: string
    PublicCheckoutMethodDto:
      type: object
      properties:
        method:
          type: string
          enum:
            - pix
            - boleto
            - card
        provider:
          type: string
          description: >-
            `sandbox` for a test debt: the sample PIX, paid only with "Simular
            pagamento".
        cardMode:
          type: string
          enum:
            - embedded_sdk
            - hosted_redirect
        publicKey:
          type: string
          description: >-
            Only set for method:'card' with cardMode:'embedded_sdk' — the
            seller's public key for the card SDK.
        maxInstallments:
          type: number
      required:
        - method
        - provider

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.