Documentação
  1. GESTÃO DE CADASTROS
  2. Estabelecimentos
  3. Gateway do Estabelecimento

Exibir gateway do estabelecimento

Esta rota retorna os dados de configuração do gateway associado a um estabelecimento, incluindo status da ativação, dados bancários e metadados relacionados à subadquirente.

🔼

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

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

Parâmetros da Requisição

Headers

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

NomeTipoObrigatórioDescrição
idstringSimID do estabelecimento a ser consultado.
gatewayIdstringSimID do gateway a ser exibido.

✅ Exemplo de Resposta

{
  "id": 1,
  "gateway": {
    "id": 10,
    "name": "PagSeguro"
  },
  "establishment_id": 101,
  "gateway_key": "abc123-xyz",
  "status": "PENDING",
  "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": {
    "account_check_digit": "1",
    "account_number": "123456",
    "bank_id": 341,
    "routing_check_digit": "9",
    "routing_number": "1234",
    "type": "CHECKING"
  },
  "metadata": {
    "code": "123",
    "email": "[email protected]",
    "token": "456",
    "statement_descriptor": "X Pagamentos"
  },
  "created_at": "2025-06-03T18:27:38.658Z",
  "updated_at": "2025-06-03T18:27:38.658Z"
}

📋 Tabela de Atributos da Resposta

CampoTipoObrigatórioDescrição
idnumberSimID da configuração do gateway.
gateway.idnumberSimID do gateway vinculado.
gateway.namestringSimNome de identificação do gateway.
establishment_idnumberSimID do estabelecimento relacionado à configuração.
gateway_keystringNãoChave identificadora do gateway (pode ser null).
statusstringSimStatus da ativação. Valores possíveis: PENDING, WAITING, ANALYZE, BLOCKED, CANCELED, DISAPPROVED, APPROVED.
activebooleanSimIndica se a ativação do gateway está ativa.
form_receiptstringNãoForma de recebimento. Valores: BANKACCOUNT, PAYTIME, PAGBANK, ZOOPBANK.
bank_account.account_check_digitstringSimDígito verificador da conta.
bank_account.account_numberstringSimNúmero da conta bancária.
bank_account.bank_idnumberSimID do banco (ex: 341 = Itaú).
bank_account.routing_check_digitstringSimDígito verificador da agência.
bank_account.routing_numberstringSimNúmero da agência bancária (sem dígito).
bank_account.typestringSimTipo de conta bancária. Ex: CHECKING, SAVING.
spb_accountobjetoNãoMesmo modelo da bank_account, utilizado em contextos de conta SPB.
metadata.codestringNãoCódigo de referência do gateway.
metadata.emailstringNãoEmail vinculado à subadquirente.
metadata.tokenstringNãoToken da subadquirente.
metadata.statement_descriptorstringNãoTexto que aparecerá na fatura do cliente.
created_atdatetimeSimData de criação da configuração do gateway.
updated_atdatetimeNãoData da última atualização da configuração.

⚠️ Observações

O campo gateway_key pode ser null caso ainda não tenha sido atribuído.

A estrutura de bank_account e spb_account são semelhantes, mas atendem a finalidades diferentes.

As informações do objeto metadata são utilizadas principalmente em contextos de subadquirência (ex: configuração de marketplaces).

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?