> ## 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 payment details for checkout page (public)



## OpenAPI

````yaml /openapi.json get /api/v1/pix/payments/{paymentId}
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/payments/{paymentId}:
    get:
      tags:
        - payments
      summary: Get payment details for checkout page (public)
      operationId: PixController_getPayment[0]
      parameters:
        - name: paymentId
          required: true
          in: path
          schema:
            type: string
        - name: token
          required: true
          in: query
          schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPaymentResponseDto'
        '404':
          description: Payment 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:
    PublicPaymentResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: object
        qrCode:
          type: object
          nullable: true
        ticketUrl:
          type: object
          nullable: true
        status:
          type: string
          enum:
            - PENDING
            - PAID
            - EXPIRED
            - CANCELLED
            - REFUNDED
            - FAILED
            - CHARGEBACK
        expiresAt:
          type: object
          nullable: true
        paymentMethod:
          type: string
          example: pix
        custody:
          type: boolean
          description: Charged on Payable's account on the creditor's behalf (Recebimentos)
        sandbox:
          type: boolean
          description: >-
            Sample PIX of a test (sandbox) debt: nothing is charged; pay it with
            "Simular pagamento"
        creditorName:
          type: string
          nullable: true
          description: Set when custody
      required:
        - id
        - amount
        - status
        - paymentMethod
        - custody
        - sandbox
    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

````

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