Consultar saque
curl --request GET \
--url http://localhost:3030/sellers/saques/{id} \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "http://localhost:3030/sellers/saques/{id}"
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
fetch('http://localhost:3030/sellers/saques/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/sellers/saques/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3030/sellers/saques/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3030/sellers/saques/{id}")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/sellers/saques/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amountCents": 123,
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"payer": {
"merchantId": "<string>",
"name": "<string>",
"email": "<string>",
"document": "<string>",
"documentType": "CPF",
"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>",
"documentType": "CPF",
"pixKey": "<string>",
"pixKeyMasked": "<string>",
"pixKeyType": "CPF",
"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"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}Saques
Consultar saque
Consulta um saque por ID com pagador, conta TurbofyPay e beneficiario do saque.
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>'import requests
url = "http://localhost:3030/sellers/saques/{id}"
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
fetch('http://localhost:3030/sellers/saques/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/sellers/saques/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3030/sellers/saques/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3030/sellers/saques/{id}")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/sellers/saques/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amountCents": 123,
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"payer": {
"merchantId": "<string>",
"name": "<string>",
"email": "<string>",
"document": "<string>",
"documentType": "CPF",
"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>",
"documentType": "CPF",
"pixKey": "<string>",
"pixKeyMasked": "<string>",
"pixKeyType": "CPF",
"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"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}Caso de uso
Use este endpoint para consultar os detalhes de um saque Pix especifico do merchant autenticado.Autenticacao
x-client-idx-client-secret
Request
Parametro principal:id(path): identificador Turbofy do saque.
Response de sucesso
Em200, 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.
{
"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
| HTTP | code | Quando ocorre |
|---|---|---|
400 | MERCHANT_ID_REQUIRED | Merchant nao resolvido na credencial. |
400 | INVALID_WITHDRAWAL_ID | Identificador vazio ou invalido. |
401 | CREDENTIALS_REQUIRED | Credenciais ausentes. |
401 | INVALID_CREDENTIALS | Credenciais invalidas. |
404 | NOT_FOUND | Saque 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
- Para obter a lista, use Listar saques.
- Para baixar o PDF, use Baixar comprovante de saque.
Authorizations
Client ID fornecido pela TurbofyPay.
Client Secret fornecido pela TurbofyPay.
Headers
Identificador do integrador.
Segredo de autenticacao do integrador.
Path Parameters
Identificador Turbofy do saque.
Required string length:
1 - 120Response
Saque encontrado.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Campo legado com valor generico PIX_GATEWAY quando houver gateway. Nao expõe fornecedor real.
Last modified on June 9, 2026