Listar planos comerciais

🔽
GET urlServidor/v1/marketplace/plans

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

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/plans' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Nome	Tipo	Obrigatório	Descrição
`filters`	string	Não	JSON de filtros. Ex: `{ "gateway_id": 2, "modality": "ONLINE" }`.
`search`	string	Não	Texto para busca. Pode ser utilizado para pesquisar por nome do plano.
`perPage`	number	Não	Limitado ao máximo de 100 por página.
`page`	number	Não	Número da página atual.
`sorters`	string	Não	JSON com lista de ordenadores. Ex: `[ { "column": "created_at", "direction": "DESC" } ]`.

✅ Exemplo de Resposta - 200 OK

{
    "total": 3,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 64,
            "name": "Plano Simulate Presencial Antecipado ID_30",
            "active": true,
            "gateway_id": 4,
            "description": "Plano Simulate Presencial Antecipado ID30",
            "type": "COMMERCIAL",
            "modality": "PHYSICAL",
            "allow_anticipation": true,
            "created_at": "2025-04-15T12:33:34.000Z",
            "updated_at": "2025-04-15T12:33:34.000Z",
            "categories": [
                {
                    "id": 30,
                    "name": "A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME",
                    "gateway_key": "5044"
                }
            ]
        },
        {
            "id": 60,
            "name": "Plano Venda API N-Ant",
            "active": true,
            "gateway_id": 4,
            "description": "Plano não Antecipad",
            "type": "COMMERCIAL",
            "modality": "ONLINE",
            "allow_anticipation": false,
            "created_at": "2025-02-12T19:27:46.000Z",
            "updated_at": "2025-02-12T19:27:46.000Z",
            "categories": [
                {
                    "id": 30,
                    "name": "A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME",
                    "gateway_key": "5044"
                }
            ]
        },
        {
            "id": 57,
            "name": "Plano Presencial API NANTC",
            "active": true,
            "gateway_id": 4,
            "description": null,
            "type": "COMMERCIAL",
            "modality": "PHYSICAL",
            "allow_anticipation": false,
            "created_at": "2025-02-12T18:56:58.000Z",
            "updated_at": "2025-02-12T18:56:58.000Z",
             "categories": [
                {
                    "id": 2,
                    "name": "Supermercados",
                    "gateway_key": "5422"
                }
            ]
        }
    ]
}

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Número total de registros retornados.
`page`	number	Sim	Página atual da listagem.
`perPage`	number	Sim	Número de registros por página.
`lastPage`	number	Sim	Número total de páginas disponíveis.
`data[].id`	number	Sim	Identificador único do plano.
`data[].name`	string	Sim	Nome do plano.
`data[].active`	boolean	Sim	Indica se o plano está ativo.
`data[].gateway_id`	number	Sim	Identificador do gateway associado ao plano.
`data[].description`	string	Não	Descrição detalhada do plano.
`data[].type`	string	Sim	Tipo de plano: `COMMERCIAL` (comercial) ou `STANDARD` (padrão).
`data[].modality`	string	Sim	Modalidade do plano: `ONLINE` ou `PHYSICAL`.
`data[].allow_anticipation`	boolean	Sim	Indica se o plano permite antecipação de recebíveis.
`data[].days_anticipation`	string	Sim	Indica os dias de antecipação, quando o plano não permite antecipação vem como `null`
`data[].created_at`	string	Sim	Data de criação do plano.
`data[].updated_at`	string	Sim	Data da última atualização do plano.

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.