Listar Gateways

🔽
GET urlServidor/v1/marketplace/gateways

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/gateways' \
--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	Filtros em JSON. Exemplo: `{ "status": "CREATED" }`
`search`	string	Não	Texto a ser buscado nos registros.
`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	Ordenação dos registros. Exemplo: `[{"column":"created_at","direction":"DESC"}]`

✅ Exemplo de Resposta - 200 OK

{
    "total": 3,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 6,
            "name": "CELCOIN",
            "type": "BANKING",
            "created_at": "2023-12-13T09:36:06.000Z",
            "updated_at": "2023-12-13T09:36:06.000Z"
        },
        {
            "id": 4,
            "name": "PAYTIME",
            "type": "ACQUIRER",
            "created_at": "2023-06-21T15:06:02.000Z",
            "updated_at": "2023-06-21T15:06:02.000Z"
        },
        {
            "id": 2,
            "name": "PAGSEGURO",
            "type": "ACQUIRER",
            "created_at": "2023-06-21T15:06:02.000Z",
            "updated_at": "2023-06-21T15:06:02.000Z"
        }
    ]
}

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Total de registros disponíveis para os filtros aplicados.
`page`	number	Sim	Página atual retornada.
`perPage`	number	Sim	Quantidade de itens por página.
`lastPage`	number	Sim	Número total de páginas disponíveis.
`data`	array	Sim	Lista com os gateways encontrados.
`data[].id`	number	Sim	Identificador único do gateway.
`data[].name`	string	Sim	Nome de identificação do gateway.
`data[].type`	string	Sim	Tipo do gateway (ex: `PAGSEGURO`, `PAYTIME`, `BANKING`).
`data[].created_at`	string(date-time)	Sim	Data e hora de criação do registro.
`data[].updated_at`	string(date-time)	Sim	Data e hora da última atualização do registro.

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.