Ir para o conteúdo
P Prontopag API PixPáginas

Consultar saque

Devolve o saque pelo idEnvio, com o status atual.

GET /v2/ex/pix/{idEnvio}

Escopo: ex.pix.send.read.

GET /v2/ex/pix/SAQ01J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "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": "fulano@exemplo.com", "cpf": "12345678909" },
  "referenciaExterna": "saque-778812",
  "infoPagador": "Saque pedido 778812",
  "origem": "API",
  "sla": { "estouradoNaEntrada": false, "restanteSegundos": 7199 }
}

origem é API quando o saque veio da sua integração e PAINEL quando alguém da sua equipe o enviou pelo painel, a um favorecido cadastrado. No PAINEL, origemLogin traz o login de quem enviou.

Um saque liquidado traz liquidadoEm e sla.cumprido:

{
  "idEnvio": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
  "status": "REALIZADO",
  "liquidadoEm": "2026-09-18T12:00:09Z",
  "sla": { "cumprido": true, "estouradoNaEntrada": false }
}

Um saque NAO_REALIZADO traz motivo com codigo e classe:

GET /v2/ex/pix/SAQ02J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "idEnvio": "SAQ02J1ZK7M9QW3ERT5TY6UI8O",
  "status": "NAO_REALIZADO",
  "tipo": "SAQUE",
  "valor": "20.00",
  "liquidadoEm": "2026-09-18T11:00:09Z",
  "motivo": { "codigo": "AC03", "classe": "CORRIGIVEL" }
}

classe é CORRIGIVEL quando outra chave ou conta resolve, RETRYAVEL quando o mesmo pedido pode passar mais tarde e TERMINAL quando não se repete.

Pelo endToEndId #

GET /v2/ex/pix/e2e/{e2eId}

GET /v2/ex/pix/e2e/E12345678202609181200000000000003
→ 200
{
  "idEnvio": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
  "endToEndId": "E12345678202609181200000000000003",
  "status": "EM_PROCESSAMENTO"
}

Comprovante #

GET /v2/ex/comprovantes/{idEnvio} devolve o comprovante em PDF de um saque REALIZADO. Antes disso responde 422 saque_nao_liquidado.

Erros #

Status title Quando
404 nao_encontrado O idEnvio não existe nesta conta.
422 saque_nao_liquidado Comprovante de um saque que ainda não liquidou.