🔑 Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

📦 Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/representatives' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

🔍 Query Params

Nome	Tipo	Obrigatório	Descrição	Exemplo
`filters`	string (JSON)	❌ Não	Filtros aplicáveis à listagem. Campos filtráveis: `active`	`{ "active": true }`
`search`	string	❌ Não	Texto livre para busca. Pesquisa em campos como `first_name`, `last_name`, `document`.	`"Tech"`
`perPage`	number	❌ Não	Limitado ao máximo de 100 por página.	`10`
`page`	number	❌ Não	Página a ser retornada.	`1`
`sorters`	string (JSON)	❌ Não	Ordenação da listagem. Campos ordenáveis: `id`, `created_at`, `updated_at`.	`[{"column":"created_at","direction":"DESC"}]`

✅ Resposta de Sucesso — 200 OK

{
    "total": 1,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 63,
            "active": true,
            "created_at": "2025-04-10T17:18:39.000Z",
            "updated_at": "2025-04-10T17:30:53.000Z",
            "deleted_at": null,
            "establishment": {
                "first_name": "EC  Cobranças API",
                "last_name": null,
                "document": "10068114001",
                "owner": {
                    "first_name": "EC Cobranças API",
                    "last_name": null,
                    "document": "10068114001"
                }
            },
            "states": [
                {
                    "id": 12,
                    "initials": "MS",
                    "name": "Mato Grosso do Sul"
                }
            ],
            "royalties": {
                "pix": 1,
                "ted": 1,
                "debit": 1,
                "billet": 1,
                "credit": 1
            }
        }
    ]
}

📘 Descrição dos Campos

🔹 Campos principais

Campo	Tipo	Descrição
`id`	number	Identificador único do representante.
`active`	boolean	Indica se o representante está ativo (`true`) ou inativo (`false`).
`created_at`	string (date-time)	Data de criação do registro.
`updated_at`	string (date-time)	Data da última atualização.
`deleted_at`	string (date-time)	Data de exclusão lógica (se aplicável).

🔹 Objeto states

Campo	Tipo	Descrição
`id`	number	Identificador do estado.
`initials`	string	Sigla do estado (ex: `SP`, `RJ`).
`name`	string	Nome completo do estado.

🔹 Objeto establishment

Campo	Tipo	Descrição
`first_name`	string	Nome / razão social do estabelecimento representado.
`last_name`	string	Sobrenome / nome fantasia.
`document`	string	CPF ou CNPJ do estabelecimento.

🔹Subobjeto owner

Campo	Tipo	Descrição
`first_name`	string	Nome / razão social do responsável.
`last_name`	string	Sobrenome / nome fantasia.
`document`	string	CPF / CNPJ do responsável.

🔹 Objeto royalties

Campo	Tipo	Descrição
`pix`	number	Percentual de royalty aplicado em operações via Pix.
`ted`	number	Percentual de royalty aplicado em operações via TED.
`debit`	number	Percentual de royalty aplicado em operações via débito.
`billet`	number	Percentual de royalty aplicado em operações de boleto.
`credit`	number	Percentual de royalty aplicado em operações de crédito.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.