Listar carteiras

Este endpoint permite listar todas as carteiras associadas a um vendedor específico ou filtrar por determinados critérios.

Visão Geral

Este endpoint permite listar todas as carteiras associadas a um vendedor específico ou filtrar por determinados critérios.

Precauções

Utilize os parâmetros de paginação para gerenciar grandes volumes de dados.
Certifique-se de utilizar o ID correto do vendedor para obter as carteiras associadas.
Os resultados são ordenados por data de criação, do mais recente para o mais antigo.

A listagem de carteiras permite visualizar todas as contas bancárias configuradas para um vendedor. Este endpoint é útil para verificar quais carteiras estão disponíveis antes de realizar operações como exclusão ou atualização.

Requisição

GET /v1/wallets

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
`limit`	integer	Não	Número de registros por página (1–100, padrão `20`)	`25`
`offset`	integer	Não	Posição inicial para paginação (padrão `0`)	`0`
`sort`	string	Não	Critério de ordenação dos resultados (`ascending` / `descending`)	`descending`
`id`	string	Não	Filtra por um ID de carteira específico (`wall_*`)	`"wall_01hqzvabc"`
`daterange`	string	Não	Filtra por data de criação (`YYYY-MM-DD` ou datetime ISO 8601)	`2026-04-12`
`daterangegt` / `daterangegte` / `daterangelt` / `daterangelte`	string	Não	Filtros de intervalo por data de criação (datetime ISO 8601)	`2026-04-01T00:00:00Z`

Não há filtro primary. Para a carteira principal, identifique o item com primary: true no resultado.

Exemplo de Requisição

GET /v1/wallets?limit=25&offset=0

Resposta

Sucesso (200 OK)

Resposta paginada no nível raiz (com merchant e _links).

{
  "offset": 0,
  "limit": 25,
  "total": 1,
  "hasMore": false,
  "page": {
    "current": 1,
    "total": 1,
    "offset": { "first": 0, "prev": 0, "next": 0, "last": 0 }
  },
  "data": [
    {
      "id": "wall_01hqzvabc",
      "name": "Minha Carteira Principal",
      "holderName": "João Santos",
      "bankName": null,
      "bankCode": "260",
      "routingNumber": "0001",
      "accountNumber": "11111111-5",
      "accountType": "checking",
      "pixKey": null,
      "primary": true,
      "enabled": true,
      "updatedAt": "2026-04-12T17:56:33.000Z",
      "createdAt": "2026-04-12T17:56:33.000Z"
    }
  ],
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/wallets",
      "method": "GET",
      "description": "List all wallets."
    },
    "create": {
      "href": "https://api.selectwin.io/v1/wallets",
      "method": "POST",
      "description": "Create a new wallet."
    }
  }
}

Atributos da Resposta Paginada

Atributo	Tipo	Descrição
`offset`	integer	Posição inicial dos resultados retornados
`limit`	integer	Quantidade máxima de registros retornados
`total`	integer	Total de registros disponíveis para a consulta
`hasMore`	boolean	Indica se existem mais resultados além dos retornados
`page.current`	integer	Número da página atual
`page.total`	integer	Total de páginas disponíveis
`page.offset.first` / `.prev` / `.next` / `.last`	integer	Offsets de navegação de páginas
`data`	array	Carteiras (objeto completo por item, sem `_links` no item)
`merchant`	object	Merchant da conta
`_links`	object	Links HATEOAS (no nível raiz)

Melhores Práticas

Utilize paginação para lidar com grandes volumes de dados, especialmente para vendedores com muitas carteiras.
Identifique a carteira principal pelo item com primary: true no resultado (não há filtro de consulta para isso).
Verifique a resposta de paginação para garantir que você tenha acessado todos os registros disponíveis.
Utilize cache quando apropriado para melhorar o desempenho ao fazer consultas frequentes.
Limite o número de requisições para respeitar os limites de taxa da API.
Armazene os IDs das carteiras para referência futura quando precisar interagir com elas individualmente.

Listar carteiras

On this page