> ## Documentation Index > Fetch the complete documentation index at: https://docs.visorfinance.app/llms.txt > Use this file to discover all available pages before exploring further. # Get a Pix payment > Returns the status of a Pix you started. Poll it every few seconds until `status` is `completed`, `failed`, `canceled`, or `expired`. While it is `pending`, `start_url` opens the page the user needs next. Requires the `pix:payments:write` scope (Visor CLI login). ## OpenAPI ````yaml /openapi.json get /v1/pix-payments/{pix_payment_id} openapi: 3.0.3 info: description: >- Personal REST API for Visor Pro and Premium users. Authenticate with a personal API token created in Visor Settings, sent as `Authorization: Bearer visor_pat_...`, or with an OAuth access token from the Visor CLI browser login. title: Visor Personal API version: 1.0.0 servers: - url: https://api.visorfinance.app variables: {} security: - personal_api_token: [] - visor_cli_oauth: - pfm:read tags: [] paths: /v1/pix-payments/{pix_payment_id}: get: tags: - Pix payments summary: Get a Pix payment description: >- Returns the status of a Pix you started. Poll it every few seconds until `status` is `completed`, `failed`, `canceled`, or `expired`. While it is `pending`, `start_url` opens the page the user needs next. Requires the `pix:payments:write` scope (Visor CLI login). operationId: VisorWeb.Api.V1.PixPaymentController.show parameters: - description: A Pix payment `id` from `POST /v1/pix-payments` in: path name: pix_payment_id required: true schema: format: uuid type: string responses: '200': content: application/json: example: data: amount: '20.00' bank: linked: true name: Nubank created_at: '2026-10-22T15:31:02Z' currency: BRL description: Almoço end_to_end_id: E60746948202610221531abcdef123456 failure: null id: 7b2d5e91-3c4a-4f68-9a0b-1c2d3e4f5a6b paid_at: '2026-10-22T15:32:40Z' pix_key_masked: '***.456.789-**' recipient: Maria da Silva start_url: null status: completed waiting_for: null schema: $ref: '#/components/schemas/PixPaymentResponse' description: The Pix payment headers: x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '401': content: application/json: example: errors: - code: INVALID_TOKEN details: {} message: The personal API token is not valid. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Missing, invalid, expired, or revoked token headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '403': content: application/json: example: errors: - code: INSUFFICIENT_SCOPE details: required_scope: pix:payments:write message: The personal API token does not grant this operation. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: >- Pro or Premium plan required, insufficient scope, or Pix not available for the account headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '404': content: application/json: example: errors: - code: NOT_FOUND details: {} message: The resource does not exist. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: The Pix payment does not exist, or the token's user cannot access it headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '406': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The client does not accept JSON headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '429': content: application/json: example: errors: - code: RATE_LIMITED details: retry_after_seconds: 42 message: >- Too many requests. Retry after the number of seconds in Retry-After. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit exceeded headers: retry-after: description: Seconds until the current window ends schema: example: 42 type: integer style: simple x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple callbacks: {} security: - visor_cli_oauth: - pix:payments:write components: schemas: PixPaymentResponse: additionalProperties: false properties: data: $ref: '#/components/schemas/PixPayment' required: - data title: PixPaymentResponse type: object ErrorResponse: additionalProperties: false properties: errors: items: $ref: '#/components/schemas/Error' minItems: 1 type: array required: - errors title: ErrorResponse type: object PixPayment: additionalProperties: false properties: amount: description: The amount in BRL as a decimal string example: '20.00' format: decimal type: string bank: allOf: - $ref: '#/components/schemas/PixPaymentBank' description: The bank the Pix comes from; `null` before a bank is chosen nullable: true created_at: format: date-time type: string currency: example: BRL type: string description: nullable: true type: string end_to_end_id: description: The Pix end-to-end id of a completed Pix nullable: true type: string failure: allOf: - $ref: '#/components/schemas/PixPaymentFailure' description: Set when the status is `failed` nullable: true id: format: uuid type: string paid_at: format: date-time nullable: true type: string pix_key_masked: description: The Pix key with its middle hidden type: string recipient: description: The recipient name, once the bank returns it nullable: true type: string start_url: description: >- The page to open in the browser while the Pix is `pending`: the bank page on the first Pix from a bank, then the page where the user confirms with biometrics. Only the user who started the Pix gets it. format: uri nullable: true type: string status: description: >- `pending` while the user authorizes the bank or confirms the Pix. Only `completed` means the Pix was paid; `failed`, `canceled`, and `expired` are final. enum: - awaiting_confirmation - pending - completed - failed - canceled - expired type: string waiting_for: description: The step the user does next while the Pix is `pending`, else `null` enum: - bank_authorization - payment_confirmation nullable: true type: string required: - id - status - waiting_for - amount - currency - pix_key_masked - recipient - description - bank - start_url - end_to_end_id - failure - created_at - paid_at title: PixPayment type: object Error: additionalProperties: false properties: code: description: Stable machine-readable code example: INVALID_TOKEN type: string details: additionalProperties: true description: Code-specific context type: object message: description: English text for developers type: string request_id: description: The x-request-id response header of the request nullable: true type: string required: - code - message - details - request_id title: Error type: object PixPaymentBank: additionalProperties: false properties: linked: description: >- `false` while the user still has to authorize Visor at the bank. The first Pix from a bank opens the bank page. type: boolean name: example: Nubank type: string required: - name - linked title: PixPaymentBank type: object PixPaymentFailure: additionalProperties: false properties: code: description: The provider or Visor code of the failure example: SALDO_INSUFICIENTE type: string message: description: Text for the user, in the language of their Visor account type: string required: - code - message title: PixPaymentFailure type: object securitySchemes: personal_api_token: bearerFormat: visor_pat__ description: Personal API token created in Visor Settings scheme: bearer type: http visor_cli_oauth: description: >- OAuth 2.0 access token of the Visor CLI browser login (authorization code with PKCE). Only the first-party Visor CLI client can use it on this API. flows: authorizationCode: authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize refreshUrl: https://dashboard.visorfinance.app/oauth/token scopes: pfm:read: Read financial data pfm:transactions:write: Create, edit, and delete transactions pix:payments:write: Start Pix payments that you confirm with biometrics at your bank tokenUrl: https://dashboard.visorfinance.app/oauth/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.