Consultar transferências
Lista transferências PIX e filtra por status.
GET
/v1/transfersChave de APIListar transferências#
GET
/v1/transfersChave de APIParâmetros de consulta
pageintegeropcionalPágina, começando em 1.
per_pageintegeropcionalDe 1 a 100. Padrão 25.
statusstringopcionalFiltra por status. Aceita lista separada por vírgula.
Status possíveis#
| Status | Significa |
|---|---|
pending | Criada, aguardando execução. |
scheduled | Agendada para uma data futura. |
processing | Em execução. |
completed | Valor entregue ao destino. |
failed | Falhou. O motivo vem em failed_reason. |
canceled | Cancelada antes da execução. |
Para saques, use GET /v1/payouts e GET /v1/payouts/{id}, com os mesmos parâmetros de paginação.
GET/v1/transfers
curl -G https://api.kyvopay.com.br/v1/transfers \
-H "X-API-Key: $KYVO_API_KEY" \
-d status=completed \
-d page=1 \
-d per_page=25200 OKresposta
{
"data": {
"items": [
{
"id": "trf_4Gh1Wq62",
"kind": "pix",
"status": "completed",
"amount_centavos": 25000,
"executed_at": "2026-08-11T21:02:14Z"
}
],
"page": 1,
"per_page": 25,
"total": 1
},
"error": null,
"request_id": "req_2d0c9f81"
}