Skip to main content
GET
/
sellers
/
saques
Listar saques
curl --request GET \
  --url http://localhost:3030/sellers/saques \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "withdrawals": [
    {
      "id": "<string>",
      "amountCents": 123,
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "payer": {
        "merchantId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "document": "<string>",
        "institution": "<string>",
        "account": {
          "institution": "<string>",
          "type": "<string>",
          "holderName": "<string>",
          "holderDocument": "<string>",
          "branch": "<string>",
          "account": "<string>"
        }
      },
      "sourceAccount": {
        "institution": "<string>",
        "type": "<string>",
        "holderName": "<string>",
        "holderDocument": "<string>",
        "branch": "<string>",
        "account": "<string>"
      },
      "beneficiary": {
        "name": "<string>",
        "document": "<string>",
        "documentMasked": "<string>",
        "pixKey": "<string>",
        "pixKeyMasked": "<string>",
        "account": {
          "institution": "<string>",
          "type": "<string>",
          "holderName": "<string>",
          "holderDocument": "<string>",
          "branch": "<string>",
          "account": "<string>"
        }
      },
      "tracking": {
        "providerTransferId": "<string>",
        "endToEndId": "<string>"
      },
      "userId": "<string>",
      "feeCents": 123,
      "totalDebitedCents": 123,
      "provider": "<string>",
      "providerTransferId": "<string>",
      "providerEndToEndId": "<string>",
      "transferaTxId": "<string>",
      "failureReason": "<string>",
      "idempotencyKey": "<string>",
      "processedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

​
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: 
{
  "withdrawals": [
    {
      "id": "withdrawal-1",
      "amountCents": 1690,
      "status": "COMPLETED",
      "provider": "PIX_GATEWAY",
      "payer": {
        "merchantId": "merchant-123",
        "name": "Loja Recebedora",
        "document": "12345678000195",
        "documentType": "CNPJ",
        "institution": "TurbofyPay",
        "account": {
          "institution": "TurbofyPay",
          "type": "Conta de pagamento",
          "holderName": "Loja Recebedora",
          "holderDocument": "12345678000195"
        }
      },
      "sourceAccount": {
        "institution": "TurbofyPay",
        "type": "Conta de pagamento",
        "holderName": "Loja Recebedora",
        "holderDocument": "12345678000195"
      },
      "beneficiary": {
        "name": "Favorecido Teste",
        "document": "12345678901",
        "documentMasked": "123.***.***-01",
        "documentType": "CPF",
        "pixKey": "favorecido@example.com",
        "pixKeyMasked": "fa***om",
        "pixKeyType": "EMAIL",
        "account": {
          "institution": "Banco Destino",
          "branch": null,
          "account": null
        }
      },
      "tracking": {
        "providerTransferId": "wd-provider-1",
        "endToEndId": "E18236120260607183551695f8fa2a"
      },
      "createdAt": "2026-06-07T18:35:20.000Z",
      "processedAt": "2026-06-07T18:35:39.000Z"
    }
  ]
}

​
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

curl --request GET \
  --url https://api.turbofypay.com/sellers/saques \
  --header "x-client-id: <client-id>" \
  --header "x-client-secret: <client-secret>"

​
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