Listar Transferências

Listar Transferências

get

Retorna uma lista paginada de transferências do vendedor com status SUCCESS.

Cada transferência inclui os lançamentos financeiros vinculados no campo statements.

Regras de filtro por data:

• startDate e endDate são opcionais.
• endDate só pode ser informado se startDate também for.
• O intervalo entre startDate e endDate não pode ultrapassar 60 dias.

Authorizations

X-Token-ApistringRequired

Chave de API do vendedor

Query parameters

startDatestring · dateOptional

Data inicial do filtro (formato ISO 8601 YYYY-MM-DD)

Example: 2025-01-01

endDatestring · dateOptional

Data final do filtro (formato ISO 8601 YYYY-MM-DD). Requer que startDate também seja informado. O intervalo máximo permitido é de 60 dias.

Example: 2025-01-31

pageintegerOptional

Número da página (base zero)

Default: 0Example: 0

sizeintegerOptional

Quantidade de registros por página

Default: 20Example: 20

sortstringOptional

Ordenação dos resultados (ex. executionDate,desc)

Example: executionDate,desc

Responses

200

Lista de transferências retornada com sucesso

application/json

totalElementsintegerOptional

Total de registros encontrados

Example: 42

totalPagesintegerOptional

Total de páginas disponíveis

Example: 3

sizeintegerOptional

Tamanho da página

Example: 20

numberintegerOptional

Número da página atual (base zero)

Example: 0

400

Parâmetro inválido. Ocorre quando endDate é informado sem startDate, ou quando o intervalo entre as datas ultrapassa 60 dias.

application/json

401

Token de API ausente ou inválido

application/json

403

Token sem permissão de vendedor

application/json

get/v3/sellers/transfers

GET /v3/sellers/transfers HTTP/1.1
Host: api.barte.com
X-Token-Api: YOUR_API_KEY
Accept: */*

{
  "content": [
    {
      "transferUuid": "f42d6d5d-7240-453e-8522-245793e44353",
      "amount": 500,
      "executionDate": "2025-01-15",
      "statements": [
        {
          "statementUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "type": "CREDIT_PIX",
          "typeDescription": "Crédito",
          "amount": 515,
          "executionDate": "2025-01-15T10:30:00"
        },
        {
          "statementUuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          "type": "DEBIT_BARTE_FEE",
          "typeDescription": "Taxa Barte",
          "amount": -15,
          "executionDate": "2025-01-15T10:30:00"
        }
      ]
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0
}