Skip to main content
GET
Consultar saque

Caso de uso

Use este endpoint para consultar os detalhes de um saque Pix especifico do merchant autenticado.

Autenticacao

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

Request

Parametro principal:
  • id (path): identificador Turbofy do saque.

Response de sucesso

Em 200, a API retorna o objeto do saque com:
  • payer: merchant dono do saldo e pagador operacional do saque.
  • sourceAccount: conta TurbofyPay do merchant, tratada como instituicao de pagamento.
  • beneficiary: recebedor real do saque.
  • tracking: identificadores usados para conciliacao Pix.
Exemplo parcial:

Erros comuns reais

Regras de negocio

  • O saque so e retornado se pertencer a um usuario do merchant autenticado.
  • A TurbofyPay aparece como instituicao da conta de pagamento do merchant, nao como beneficiario final.
  • O beneficiario vem do snapshot persistido do saque; se o dado nao existir em saque antigo, a API retorna null.
  • O endpoint nao retorna rawPayload, PDF base64, token ou nome real do fornecedor.

Exemplo de codigo

Proximos passos

  1. Para obter a lista, use Listar saques.
  2. Para baixar o PDF, use Baixar comprovante de saque.

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 Turbofy do saque.

Required string length: 1 - 120

Response

Saque encontrado.

id
string
required
amountCents
integer
required
status
string
required
createdAt
string<date-time>
required
payer
object | null
required
sourceAccount
object
required
beneficiary
object | null
required
tracking
object
required
userId
string
feeCents
integer
totalDebitedCents
integer
provider
string | null

Campo legado com valor generico PIX_GATEWAY quando houver gateway. Nao expõe fornecedor real.

providerTransferId
string | null
providerEndToEndId
string | null
transferaTxId
string | null
failureReason
string | null
idempotencyKey
string | null
processedAt
string<date-time> | null
Last modified on June 9, 2026