Skip to main content
GET
Consultar pagamento Pix por QR Code

Caso de uso

Use esta operação para acompanhar um pagamento iniciado por Solicitar pagamento por QR Pix.

Autenticação

  • x-client-id
  • x-client-secret
  • Escopo payout:read

Request

  • paymentId (path): UUID retornado ao solicitar o pagamento.

Resposta

Em 200, a API retorna paymentId, status, amountCents, feeCents, totalDebitedCents, currency, endToEndId e failureCode. endToEndId e failureCode podem ser null. currency é sempre BRL. Quando status é FAILED, failureCode é PIX_QR_PAYMENT_FAILED. Os estados públicos são QUEUED, PROCESSING, RECONCILIATION_REQUIRED, COMPLETED e FAILED. A consulta é restrita ao merchant autenticado. Um paymentId inexistente ou pertencente a outro merchant retorna 404.

Próximos passos

  1. Para iniciar um pagamento, siga o fluxo em Pagar com QR Pix.
  2. Use o endToEndId retornado quando disponível para conciliação.

Authorizations

x-client-id
string
header
required

Client ID fornecido pela TurbofyPay.

x-client-secret
string
header
required

Client Secret fornecido pela TurbofyPay.

Headers

x-client-id
string
required

Identificador do integrador.

x-client-secret
string
required

Segredo de autenticacao do integrador.

Path Parameters

paymentId
string<uuid>
required

Response

Default Response

paymentId
string<uuid>
required
status
enum<string>
required
Available options:
QUEUED,
PROCESSING,
RECONCILIATION_REQUIRED,
COMPLETED,
FAILED
amountCents
integer
required
Required range: x >= 0
feeCents
integer
required
Required range: x >= 0
totalDebitedCents
integer
required
Required range: x >= 0
currency
enum<string>
required
Available options:
BRL
endToEndId
string | null
required
failureCode
string | null
required
Last modified on November 12, 2026