Skip to main content
GET
Listar saques

Caso de uso

Use este endpoint para consultar os saques Pix do merchant autenticado e reconciliar quem pagou, por qual conta TurbofyPay, e quem recebeu o saque.

Autenticacao

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

Response de sucesso

Em 200, a API retorna withdrawals, uma lista de saques com:
  • payer: merchant dono do saldo, com documento e instituicao TurbofyPay.
  • sourceAccount: conta de pagamento TurbofyPay usada como origem do saque.
  • beneficiary: pessoa ou empresa que recebeu o saque, com documento, Pix e dados de conta quando persistidos.
  • tracking: identificadores de conciliacao, incluindo providerTransferId e endToEndId quando disponiveis.
Exemplo parcial:

Regras de negocio

  • A consulta retorna somente saques do merchant autenticado pelas credenciais.
  • A API usa dados persistidos do saque e do snapshot de pagamento; nao consulta gateways de pagamento durante a listagem.
  • provider e um campo legado com valor generico PIX_GATEWAY quando houver gateway. A TurbofyPay nao expõe o fornecedor real.
  • Se o saque antigo nao tiver snapshot de beneficiario, beneficiary retorna campos null em vez de inventar dados.

Exemplo de codigo

Proximos passos

  1. Consulte um saque especifico em Consultar saque.
  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.

Response

Saques encontrados para o seller autenticado.

withdrawals
object[]
required
Last modified on June 9, 2026