Skip to main content
GET
https://api.pronttus.com.br
/
v1
/
merchants
curl -X GET "https://api.pronttus.com.br/v1/merchants?page=1&limit=10" \
  -H "Authorization: Bearer seu_token"

{
  "data": [
    {
      "merchantId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "João da Silva",
      "document": "12345678901",
      "document_type": "CPF",
      "email": "[email protected]",
      "phone": "11999999999",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}

​
Visão Geral

Este endpoint permite listar todos os merchants criados na sua conta com suporte a paginação e filtros.

​
Autenticação

​
Authorization
string
required
Token Bearer obtido no endpoint de autenticação Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...

​
Parâmetros de Query

​
page
integer
default:"1"
Número da página para paginação
​
limit
integer
default:"10"
Quantidade de merchants por página (máximo: 100)
​
status
string
Filtrar por status: ACTIVE, INACTIVE, SUSPENDED
curl -X GET "https://api.pronttus.com.br/v1/merchants?page=1&limit=10" \
  -H "Authorization: Bearer seu_token"

{
  "data": [
    {
      "merchantId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "João da Silva",
      "document": "12345678901",
      "document_type": "CPF",
      "email": "[email protected]",
      "phone": "11999999999",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}

​
Campos da Resposta

​
data
array
Array com os merchants encontrados
​
data[].merchantId
string
UUID único do merchant
​
data[].name
string
Nome do merchant
​
data[].document
string
CPF ou CNPJ do merchant
​
data[].document_type
string
Tipo do documento: CPF ou CNPJ
​
data[].email
string
E-mail do merchant
​
data[].phone
string
Telefone do merchant
​
data[].status
string
Status do merchant: ACTIVE, INACTIVE, SUSPENDED
​
data[].createdAt
string
Data de criação (ISO 8601)
​
pagination
object
Informações de paginação
​
pagination.page
integer
Página atual
​
pagination.limit
integer
Limite por página
​
pagination.total
integer
Total de merchants
​
pagination.totalPages
integer
Total de páginas