API Reference
Consultar TEV
GET /v1/tev/:id — consulta a transferência interna pela origem ou pelo destino.
Consulta TEV
Consulta uma transferência interna (TEV) pelo id. Tanto a conta de origem quanto a de destino podem consultar — cada lado enxerga a própria direção, a própria tarifa e a contraparte.
GET/v1/tev/:id
Quando quem consulta é a conta de destino, o response vem com direction: "in", o campo origin no lugar de destination e feeCents com a tarifa de recebimento daquele lado. Contas sem relação com a transferência recebem 404. Use este endpoint para acompanhar um POST /v1/tev que retornou submitted_unknown até o status virar DONE ou FAILED.
Path params
- idObrigatóriostringtevId retornado por POST /v1/tev.
Headers
- AuthorizationObrigatóriostringBearer SUA_API_KEY
- X-Pix-Account-IdstringSeleciona a conta quando a chave tem acesso a várias.
Exemplo de requisição
bash
curl https://api.staterpay.io/v1/tev/cmoxample0001qkxyztev000 \ -H "Authorization: Bearer SUA_API_KEY"Resposta
- idstringIdentificador da transferência.
- status"DONE" | "FAILED" | "SUBMITTED_UNKNOWN"DONE = liquidada; FAILED = recusada (valor devolvido); SUBMITTED_UNKNOWN = em resolução automática.
- direction"out" | "in"out quando a conta consultante é a origem; in quando é o destino.
- amountCentsstringValor transferido em centavos.
- feeCentsstringTarifa do lado consultante: tarifa de envio quando direction=out, de recebimento quando direction=in.
- descriptionstring | nullDescrição enviada na criação.
- externalRefstring | nullReferência externa enviada na criação.
- destination{ branch, account }Conta de destino. Presente apenas quando direction=out.
- origin{ branch, account }Conta de origem. Presente apenas quando direction=in.
- createdAtstring (ISO-8601)Criação da transferência.
- resolvedAtstring | nullMomento da resolução final (liquidação ou falha).
json
{ "id": "cmoxample0001qkxyztev000", "status": "DONE", "direction": "out", "amountCents": "1500", "feeCents": "0", "description": "Repasse interno pedido #123", "externalRef": "pedido-2026-0001", "destination": { "branch": "1", "account": "598375" }, "createdAt": "2026-08-19T10:12:44.120-03:00", "resolvedAt": "2026-08-19T10:12:44.905-03:00"}URL base:
https://api.staterpay.io