📑 Fluxo de Ativação e Aprovação de Gateway

Atenção

Cada Gateway possui regras e particularidades próprias. É importante compreender os cenários de uso antes de iniciar a ativação.

🔗 Vínculo de Gateways ao Estabelecimento

Ao cadastrar um estabelecimento defina quais Gateways estarão vinculados, conforme serviços contratados na Paytime.

⚙️ Etapas de Ativação

Ativação do Banking Paytime (Gateway ID 6)

1. 1. Utilize a rota:
      cURL

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

• Informe os seguintes parâmetros:
  • "gateway_id": 6
  • "active":true
  • "form_receipt": "PAYTIME"
  • "fees_banking_id": id_da_tarifa_bancária

Modelo Body Ativação Banking Paytime

{
  "reference_id": "NumeroQueParceiroUsa",
  "gateway_id":6,
  "active": true,
  "form_receipt": "PAYTIME",
  "fees_banking_id": 0//ID da Tarifa Bancaria
}

📘 Para consultar os pacotes de tarifas bancárias, veja a documentação: Listar Pacotes de Tarifas Bancárias.

2. Jornada de KYC
   1. Após ativar o Gateway 6, faça uma nova requisição na rota de Ativar Gateway e a resposta conterá o link do KYC:
   JSON

   ...
   "metadata": {
      "url_documents_copy": "https://..."
   }

• ➡️ O cliente (titular do cadastro) deve seguir este link e concluir a jornada de KYC.
• Somente após a aprovação do KYC, o Banking Paytime estará habilitado.
• 📌 Nota Técnica: O uso de bloqueadores de anúncio (ad blockers) pode impactar a análise antifraude e o processo de KYC, comprometendo a validação. Recomendamos desabilitar esses bloqueadores durante a jornada de autenticação.

3. Ativação da SubPaytime (Gateway ID 4)
   1. Utilize novamente a rota:
   cURL

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

   • Consulte a documentação de Ativar gateway para o estabelecimento.
   • Informe os seguintes parâmetros:
     • "gateway_id":4
     • "form_receipt": "PAYTIME"
     • "statement_descriptor": "descrição_no_extrato"
     • "plans": [ ], vincule os planos comerciais ao estabelecimento.

Modelo Body Ativação Sub Paytime

{
  "reference_id": "NumeroQueParceiroUsa",
  "gateway_id":4,
  "active": true,
  "form_receipt": "PAYTIME",
  "statement_descriptor": "descrição_no_extrato",
  "plans": [
    {
      "id":93,
      "active": true
    }
  ]
}

📘 Para consultar os planos disponíveis para o estabelecimento, veja a documentação: Listar Planos Comerciais.

Opcional

🏦 Cadastro de Conta Bancária (BankAccount)

O recurso BANKACCOUNT deve ser utilizado caso o cliente queira cadastrar uma nova conta bancária, que deve ser vinculada diretamente ao CPF/CNPJ do Parceiro.

Modelo Body Ativação BankAccount.

{
  "reference_id": "NumeroQueParceiroUsa",
  "gateway_id":4,
  "active": true,
  "form_receipt": "BANKACCOUNT",
  "bank_account": {
    "account_check_digit": "1",
    "account_number": "456789",
    "bank_code": "341",
    "routing_check_digit": "9",
    "routing_number": "1234",
    "type": "CHECKING"
  },
  "statement_descriptor": "CadastroBanking",
  "plans": [
    {
      "id":15,
      "active": true
    }
  ],
  "fees_banking_id": 2
}

Resumo do fluxo

• A ordem de ativação deve ser seguida:
  1. Banking Paytime (ID 6)
  2. KYC
  3. SubPaytime (ID 4)

flowchart LR

A[fa:fa-code Rota utilizada<br>POST /v1/marketplace/establishments/id/gateways]

A --> B[fa:fa-university Ativar Banking Paytime<br>gateway_id: 6]

B --> C[fa:fa-link API retorna link<br>da jornada KYC]

C --> D[fa:fa-user-check Cliente realiza<br>validação KYC]

D --> E{KYC aprovado?}

E -->|Não| X[fa:fa-ban Processo interrompido<br>Gateway não habilitado]

E -->|Sim| F[fa:fa-check Banking Paytime habilitado]

F --> G[fa:fa-cogs Ativar SubPaytime<br>gateway_id: 4]

G --> H[fa:fa-check Gateway SubPaytime ativo]

• Consulte a documentação completa Ativar gateway para o estabelecimento.