Skip to main content
GET
/
sellers
/
saques
/
{id}
Consultar saque
curl --request GET \
  --url http://localhost:3030/sellers/saques/{id} \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "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 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: 
{
  "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"
    }
  },
  "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"
}

​
Erros comuns reais

HTTPcodeQuando ocorre
400MERCHANT_ID_REQUIREDMerchant nao resolvido na credencial.
400INVALID_WITHDRAWAL_IDIdentificador vazio ou invalido.
401CREDENTIALS_REQUIREDCredenciais ausentes.
401INVALID_CREDENTIALSCredenciais invalidas.
404NOT_FOUNDSaque inexistente para o merchant autenticado.

​
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

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

​
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
required
​
sourceAccount
object
required
​
beneficiary
object
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