Skip to main content
GET
Consultar cobranca PIX

Caso de uso

Use esta rota para consultar o estado de uma cobranca ja criada e sincronizar seu ERP, checkout ou painel financeiro.

Autenticacao

  • x-client-id
  • x-client-secret

Pre-condicoes e requisitos

  • O id deve ser um identificador da cobranca/transacao retornado pela Turbofy: id, externalRef, providerChargeId, pixTxid ou endToEndId.
  • A cobranca precisa pertencer ao merchant autenticado.

Request

Parametro principal:
  • id (path): identificador da cobranca PIX ou da transacao Pix vinculada.

Response de sucesso

Em 200, a API retorna:
  • id, status, amountCents, description
  • pix.qrCode, pix.copyPaste, pix.expiresAt
  • payer: pagador real da transacao com name, email, phone, document, documentType, institution, agency e account quando disponiveis
  • beneficiary: merchant recebedor da cobranca; a conta aparece como conta TurbofyPay, como uma instituicao de pagamento
  • splits (quando houver)
  • createdAt e updatedAt
Exemplo parcial:

Erros comuns reais

Regras de negocio e observacoes operacionais

  • A consulta retorna somente cobrancas do merchant autenticado.
  • O pagador vem dos dados reais da transacao Pix quando o pagamento ja foi confirmado e ha endToEndId disponivel; se a rede Pix estiver indisponivel, a API usa snapshot persistido ou metadata local.
  • O beneficiario e sempre o merchant dono da cobranca. A TurbofyPay aparece como instituicao/conta de pagamento, nao como beneficiario final.
  • Para conciliacao, persista id, status, externalRef e timestamps.
  • Alias legado /rifeiro/pix/:id existe por compatibilidade; use /sellers/pix/{id} como caminho principal.

Exemplo de codigo

Proximos passos

  1. Se ainda nao criou a cobranca, use Criar cobranca PIX.
  2. Para eventos assincronos, configure Webhooks.

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

id
string
required

Identificador da cobranca/transacao: id, externalRef, providerChargeId, pixTxid ou endToEndId.

Response

Cobranca PIX encontrada.

id
string
required
status
string
required
amountCents
integer
required
pix
object
required
createdAt
string<date-time>
required
description
string | null
splits
object[]
webhook
object | null
payer
object | null
beneficiary
object | null
updatedAt
string<date-time>
Last modified on June 8, 2026