Listar retiros
Lista los retiros de la cuenta, del más reciente al más antiguo, con cursor.
GET /v2/ex/pix
Alcance: ex.pix.send.read.
GET /v2/ex/pix?limite=2
→ 200
{
"payouts": [
{
"idEnvio": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
"endToEndId": "E12345678202609181200000000000003",
"status": "EM_PROCESSAMENTO",
"tipo": "SAQUE",
"valor": "300.00",
"solicitadoEm": "2026-09-18T12:00:00Z",
"prazoRegulatorio": "2026-09-18T14:00:00Z",
"favorecido": { "chave": "12345678909", "cpf": "12345678909" },
"sla": { "estouradoNaEntrada": false, "restanteSegundos": 7199 }
}
],
"cursor": { "proximo": "", "temMais": false }
}
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
limite |
entero | no | Elementos por página, de 1 a 200. Por defecto, 50. |
cursor |
string | no | El cursor.proximo de la página anterior. |
inicio, fim |
string | no | Intervalo de creación, cuando recibimos el retiro, RFC 3339. fim no se incluye. |
status |
string | no | AGUARDANDO_APROVACAO, EM_PROCESSAMENTO, REALIZADO o NAO_REALIZADO. |
cpf, cnpj |
string | no | Solo los retiros al beneficiario con este documento, con o sin la máscara. Uno de los dos. |
subconta |
string | no | Solo los retiros de esa subcuenta. |
ordem |
string | no | prazo: la cola del plazo, del más corto al más largo, solo con status=EM_PROCESSAMENTO y solo los retiros que tienen plazo. La primera página trae los más urgentes. Omitido, del más reciente al más antiguo. |
Cada elemento tiene la forma de Consultar retiro. El beneficiario persona jurídica viene con cnpj en lugar de cpf.
Errores #
| Estado | title |
Cuándo |
|---|---|---|
| 400 | cursor_invalido |
Cursor mal formado. |
| 400 | periodo_invalido |
inicio o fim fuera de RFC 3339. |
| 400 | limite_invalido |
limite fuera de 1 a 200. |
| 400 | status_invalido |
status fuera de la lista. |
| 400 | filtro_invalido |
ordem fuera de la lista, prazo sin status=EM_PROCESSAMENTO, o cpf y cnpj juntos. |