Listar gateways do estabelecimento

Essa rota permite consultar a lista de gateways configurados para um determinado estabelecimento, incluindo informações bancárias, status de ativação e dados adicionais.

🔼
GET urlServidor/v1/marketplace/establishments/{id}/gateways

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

Exemplo de header da requisição

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

Parâmetros da Requisição

Headers

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

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do estabelecimento.

🔎 Parâmetros de Query (Opcionais)

Nome	Tipo	Obrigatório	Descrição
`filters`	string	Não	JSON com filtros. Ex: `{ "status": "APPROVED" }`
`search`	string	Não	Texto a ser pesquisado nos dados.
`perPage`	number	Não	Quantidade de registros por página.
`page`	number	Não	Número da página.
`sorters`	string	Não	JSON com ordenadores. Ex: `[{"column":"created_at","direction":"DESC"}]`

✅ Exemplo de Resposta

{
  "total": 1,
  "page": 1,
  "perPage": 20,
  "lastPage": 1,
  "data": [
    {
      "id": 1,
      "gateway": {
        "id": 10,
        "name": "PagSeguro"
      },
      "establishment_id": 101,
      "gateway_key": "abc123xyz",
      "status": "APPROVED",
      "active": true,
      "form_receipt": "BANKACCOUNT",
      "bank_account": {
        "account_check_digit": "1",
        "account_number": "123456",
        "bank_id": 341,
        "routing_check_digit": "9",
        "routing_number": "1234",
        "type": "CHECKING"
      },
      "spb_account": null,
      "metadata": {
        "code": "123",
        "email": "[email protected]",
        "token": "456",
        "statement_descriptor": "X Pagamentos"
      },
      "created_at": "2025-06-03T18:41:01.662Z",
      "updated_at": "2025-06-03T18:41:01.662Z"
    }
  ]
}

📋 Tabela de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	ID da configuração do gateway.
`gateway`	object	Sim	Dados do gateway configurado.
`gateway.id`	number	Sim	ID do gateway.
`gateway.name`	string	Sim	Nome de identificação do gateway.
`establishment_id`	number	Sim	ID do estabelecimento associado à configuração.
`gateway_key`	string (nullable)	Não	Chave do gateway, se existir.
`status`	string	Sim	Status da configuração. Ex: `PENDING`, `APPROVED`, `BLOCKED`, etc.
`active`	boolean	Sim	Indica se o gateway está ativo.
`form_receipt`	string (nullable)	Não	Forma de recebimento. Ex: `BANKACCOUNT`, `PAYTIME`, `PAGBANK`, `ZOOPBANK`
`bank_account`	object (nullable)	Não	Conta bancária cadastrada.
`bank_account.account_check_digit`	string	Sim	Dígito verificador da conta.
`bank_account.account_number`	string	Sim	Número da conta bancária.
`bank_account.bank_id`	number	Sim	ID do banco conforme cadastro na plataforma.
`bank_account.routing_check_digit`	string	Sim	Dígito verificador da agência (se aplicável).
`bank_account.routing_number`	string	Sim	Número da agência bancária (sem dígito).
`bank_account.type`	string	Sim	Tipo da conta. Valores: `CHECKING`, `SAVING`.
`spb_account`	object (nullable)	Não	Conta SPB, utilizada em ativação BANKING.
`spb_account.account_check_digit`	string	Sim	Dígito verificador da conta.
`spb_account.account_number`	string	Sim	Número da conta bancária.
`spb_account.bank_id`	number	Sim	ID do banco conforme cadastro na plataforma.
`spb_account.routing_check_digit`	string	Sim	Dígito verificador da agência bancária (se aplicável).
`spb_account.routing_number`	string	Sim	Número da agência bancária (sem dígito).
`spb_account.type`	string	Sim	Tipo da conta bancária. Valores: `CHECKING`, `SAVING`.
`metadata`	object	Não	Informações adicionais de configuração.
`metadata.code`	string	Não	Código de controle interno.
`metadata.email`	string	Não	E-mail associado ao gateway.
`metadata.token`	string	Não	Token de autenticação interno.
`metadata.statement_descriptor`	string	Não	Nome que aparecerá na fatura do cliente.
`created_at`	string (date-time)	Sim	Data de criação da configuração.
`updated_at`	string (date-time)	Não	Data da última atualização.

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.

Updated 7 months ago

Did this page help you?