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

Ativar gateway para o estabelecimento

Essa rota permite a ativação de uma plataforma de gateway (PagSeguro, Paytime ou Banking) para um estabelecimento.

🔼

POST urlServidor/v1/marketplace/establishments/{id}/gateways

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

⚠️

Ativação de Banking e SubPaytime em SANDBOX
Para que o banking tenha o status: APPROVED precisa que o último dígito do phone objeto responsible do estabelecimento seja final 1.

Exemplo de header da requisição

curl--request POST \
--location 'POST /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

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 que será vinculado ao gateway.

📥 Modelo Payload (Body)

{
  "reference_id": "string",
  "gateway_id": 4,
  "active": true,
  "form_receipt": "BANKACCOUNT",
  "bank_account": {
    "account_check_digit": "1",
    "account_number": "123456",
    "bank_code": "341",
    "routing_check_digit": "9",
    "routing_number": "1234",
    "type": "CHECKING"
  },
  "statement_descriptor": "string",
  "plans": [
    {
      "id": 57,
      "active": true
    }
  ],
  "fees_banking_id": 0
}

🧾 Tabela de Parâmetros do Body

NomeTipoObrigatórioDescrição
reference_idstringSimPermite ao parceiro associar uma referência única da sua própria base de dados à transação ou operação executada na API da Paytime.
gateway_idnumberSimID da plataforma a ser ativada: 2 = PagSeguro, 4 = Paytime, 6 = Banking.
activebooleanSimDefine se o gateway será ativado (true) ou desativado (false).
form_receiptstringCondicionalForma de recebimento. Valores possíveis: BANKACCOUNT, PAYTIME, PAGBANK.
bank_account.account_check_digitstringCondicionalDígito verificador da conta. Obrigatório se form_receipt = BANKACCOUNT.
bank_account.account_numberstringCondicionalNúmero da conta bancária.
bank_account.bank_codestringCondicionalCode conforme cadastro no Banco Central. Exemplo: 341(Itaú) e 104(Caixa Econômica Federal)
bank_account.routing_check_digitstringCondicionalDígito verificador da agência. (Se aplicável)
bank_account.routing_numberstringCondicionalNúmero da agência bancária (sem dígito).
bank_account.typestringCondicionalTipo da conta bancária: CHECKING ou SAVING.
statement_descriptorstringCondicionalNome que aparecerá na fatura. Obrigatório para ativação do gateway Paytime.
plans[].idnumberCondicionalID do plano a ser associado. Obrigatório para Paytime e PagSeguro.
plans[].activebooleanCondicionalDefine se o plano será ativado (true) ou desativado (false).
fees_banking_idnumberCondicionalID do pacote de tarifas bancárias. Obrigatório para ativação de gateway do tipo Banking.

✅ Exemplo de Resposta

{
    "id": 371,
    "gateway": {
        "id": 4,
        "name": "PAYTIME"
    },
    "establishment_id": 155085,
    "gateway_key": "070738",
    "reference_id": "string",
    "status": "APPROVED",
    "active": true,
    "form_receipt": "BANKACCOUNT",
    "metadata": {
        "statement_descriptor": "string"
    },
    "created_at": "2025-01-09T19:16:00.000Z",
    "updated_at": "2025-06-09T20:46:21.000Z",
    "bank_account": null
}

📋 Explicação de Atributos da Resposta

CampoTipoObrigatórioDescrição
reference_idstringSimIdentificador de referência único para controle interno do parceiro.
gateway_idnumberSimID do gateway a ser ativado: 2 - PagSeguro, 4 - Paytime, 6 - Banking.
activebooleanSimDefine se o gateway será ativado (true) ou desativado (false).
form_receiptstringSimForma de recebimento: BANKACCOUNT, PAYTIME, PAGBANK.
bank_account.account_check_digitstringCondicionalDígito verificador da conta bancária. Obrigatório se form_receipt = BANKACCOUNT.
bank_account.account_numberstringCondicionalNúmero da conta bancária.
bank_account.bank_idnumberCondicionalCódigo do banco conforme cadastro da plataforma.
bank_account.routing_check_digitstringCondicionalDígito verificador da agência.
bank_account.routing_numberstringCondicionalNúmero da agência (sem dígito). Máximo 4 caracteres.
bank_account.typestringCondicionalTipo da conta bancária: CHECKING ou SAVING.
statement_descriptorstringCondicionalNome que será exibido na fatura do cliente. Obrigatório para Sub Paytime.
plans[].idnumberCondicionalID dos planos que serão associados. Obrigatório para Sub Paytime e PagSeguro.
plans[].activebooleanCondicionalFlag de ativação do plano: true - ativar, false - desativar.
fees_banking_idnumberCondicionalID do pacote de tarifas bancárias. Obrigatório para ativação Banking.

⚠️ Observações

A ativação de um gateway requer que o estabelecimento já esteja criado e com plano vinculado.

Campos como bank_account e fees_banking_id são obrigatórios somente para gateways com form_receipt: BANKACCOUNT.

Para o gateway Paytime, o campo statement_descriptor é obrigatório.


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?