Listar terminais de captura do tenant

Lista os terminais de captura (POS, TEF, virtual, etc.) dos estabelecimentos do tenant.

Dois modos de uso:

  • Sem documentId: retorna os terminais de todos os estabelecimentos do tenant
    (modo tenant-wide). A plataforma busca os identificadores Autra de cada estabelecimento
    internamente e agrega as chamadas em paralelo. Estabelecimentos ainda não inicializados
    na adquirência são silenciosamente ignorados.

  • Com documentId (CPF/CNPJ): filtra a listagem para um único estabelecimento. Caso
    ele ainda não tenha sido inicializado via POST /v1/acquiring/payments/initialize, o
    endpoint retorna 409 MERCHANT_NOT_INITIALIZED.

Em qualquer cenário, a fronteira do tenant é respeitada — o caller jamais enxerga
terminais de outros tenants, mesmo passando um CPF/CNPJ que exista em outro tenant
(retorna 404 MERCHANT_NOT_FOUND para não vazar a existência cross-tenant).

Os filtros opcionais (type, status, serialNumber, logicalNumber, model,
dtInsert*) são repassados diretamente para a adquirência.

Paginação: use page (0-indexed) e size (1–100, default 50). A paginação é
aplicada sobre o agregado, então funciona da mesma forma nos dois modos. A resposta
sempre traz total (terminais agregados antes do slice) e totalPages.

Formato da resposta: { "content": [...], "page", "size", "total", "totalPages" }.
No modo tenant-wide, content agrega terminais de todos os estabelecimentos do tenant
após a janela de paginação.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

(Opcional) CPF (11 dígitos) ou CNPJ (14 dígitos) do estabelecimento, apenas números.
Se omitido, lista terminais de todos os estabelecimentos do tenant.

string
enum

Filtro por tipo de terminal.

Allowed:
string
enum

Filtro por status do terminal.

Allowed:
string
length ≤ 64

Filtro por número de série.

string
length ≤ 8

Filtro por número lógico (TerminalId — DE41 nas integrações diretas com o Gateway).

string
length ≤ 50

Filtro por modelo do terminal.

date

Filtro por data exata de inserção (YYYY-MM-DD).

date

Filtro por data de inserção maior ou igual (YYYY-MM-DD).

date

Filtro por data de inserção menor ou igual (YYYY-MM-DD).

integer
≥ 0
Defaults to 0

Número da página (começa em 0).

integer
1 to 100
Defaults to 50

Tamanho da página (máximo 100, default 50).

Responses

403

Token inválido, IP não permitido ou tenant não identificado.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json