Skip to main content

Visão geral

Este endpoint retorna uma lista paginada de todas as transferências (Pix Out) realizadas pela sua conta, com suporte a filtros por status e período.

Endpoint

curl --request GET \
  --url "https://api.avanttifinance.com/v1/transfers?status=completed&page=1&limit=20" \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

Parâmetros de consulta

status
string
Filtra pelo status da transferência: pending, processing, completed ou failed.
start_date
string
Data inicial do período de busca (formato YYYY-MM-DD).
end_date
string
Data final do período de busca (formato YYYY-MM-DD).
page
integer
default:"1"
Número da página de resultados.
limit
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

Resposta

data
array
Lista de objetos de transferência.
pagination
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

Exemplo de resposta

{
  "data": [
    {
      "id": "trf_4d2f1a9c7b",
      "status": "completed",
      "amount": 50000,
      "pix_key": "12345678900",
      "created_at": "2026-06-10T14:28:00Z"
    },
    {
      "id": "trf_9a8b7c6d5e",
      "status": "pending",
      "amount": 12000,
      "pix_key": "joao@exemplo.com",
      "created_at": "2026-06-09T09:15:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 4,
    "total_items": 78
  }
}
Combine os filtros start_date e end_date com status para gerar relatórios financeiros precisos.

Próximos passos

Ver transferência

Consulte os detalhes completos de uma transferência específica.

Pix Out

Saiba como criar uma nova transferência.