Listar saques
curl --request GET \
--url http://localhost:3030/sellers/saques \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "http://localhost:3030/sellers/saques"
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', 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",
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"
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")
.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")
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{
"withdrawals": [
{
"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>"
}
}Saques
Listar saques
Lista saques do merchant autenticado com pagador, conta TurbofyPay e beneficiario do saque.
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>'import requests
url = "http://localhost:3030/sellers/saques"
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', 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",
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"
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")
.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")
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{
"withdrawals": [
{
"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>"
}
}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-idx-client-secret
Response de sucesso
Em200, a API retorna withdrawals, uma lista de saques com:
payer: merchant dono do saldo, com documento e instituicaoTurbofyPay.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, incluindoproviderTransferIdeendToEndIdquando disponiveis.
{
"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.
providere um campo legado com valor genericoPIX_GATEWAYquando houver gateway. A TurbofyPay nao expõe o fornecedor real.- Se o saque antigo nao tiver snapshot de beneficiario,
beneficiaryretorna camposnullem 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
- Consulte um saque especifico em Consultar saque.
- 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.
Response
Saques encontrados para o seller autenticado.
Show child attributes
Show child attributes
Last modified on June 9, 2026