Quickstart

O processo de integração com a API de Banking Gateway exige que o cumprimento de etapas seja seguido de forma linear até um determinado ponto, no qual a maioria das funcionalidades de movimentação financeira será liberada. Para isso, devem-se seguir as primeiras etapas para garantir a segurança e autenticação do processo de integração, abrir uma conta, validá-la e, por fim, iniciar suas movimentações financeiras.

Aceite o convite da Plataforma 📲

Para começar, nossa equipe enviará um convite para sua organização na Plataforma de Gerenciamento Bancário. Este convite vincula sua empresa à aplicação, permitindo o acesso aos nossos endpoints.

Configure a segurança e Gere a chave de API 🔐

Após aceitar o convite, é crucial configurar as medidas de segurança para garantir a autenticação de suas chamadas e gerar sua Chave API:

1. Configuração de mTLS: Garanta a segurança das suas conexões configurando a certificação mTLS. Guia
2. Criação de Chave de acesso via Plataforma Banking Gateway. Guia

Configure URL de Webhooks 🔗

Para receber notificações sobre eventos importantes em sua conta e transações, é fundamental configurar as URLs de webhooks.

Abra uma conta 👥

Este é o primeiro passo para começar a interagir com as funcionalidades da nossa API do Banking Gateway. É preciso criar um usuário e uma account (conta) vinculada a ele. Para saber mais, consulte as etapas abaixo:

1. Primeiramente, entenda o nosso conceito de conta;
2. Crie um usuário e uma conta vinculada.

Know Your Costumer (KYC) 🔍

Para que a conta criada possa realizar movimentações financeiras, ela deve se tornar uma conta de pagamento, isto é, uma conta validada por um serviço garantidor de identidade. Isso nos dá a certeza de que a pessoa que criou a conta é realmente a pessoa que está utilizando ela. Portanto, é preciso que o usuário complete o cadastro realizando o KYC (Know Your Customer ou “Conheça Seu Cliente”, em português).

No fluxo de KYC, requisitamos alguns dados e documentos da pessoa ou empresa que abriu a conta para passar por uma série de validações internas garantindo a integridade dos dados enviados. Com o KYC aprovado, o usuário receberá um número de agência e de conta sob a instituição Stone Pagamentos S.A. (código do banco 197). De forma resumida para seguir com a criação da conta de pagamento, é necessário:

1. Completar o fluxo de KYC;
2. Ter o KYC validado e aprovado.

Movimentação em conta 💰

Agora que a conta de pagamento foi criada, podemos realizar diversas movimentações financeiras com as funcionalidades da API do Banking Gateway:

1. Por se tratar de uma conta de pagamento recém criada, para iniciar qualquer movimentação financeira, é preciso efetuar um cash in (crédito ou entrada financeira) na conta criada. Para isto, temos os seguintes métodos:
   • Emitir um Boleto de depósito ou cobrança,
   • Gerar uma chave Pix para receber dinheiro,
2. Em seguida, já com algum saldo na conta, é possível realizar operações de cash out (débito ou saída financeira) com os seguintes tipos de transações:
   • Pagar uma conta de consumo ou boleto comum
   • Enviar um Pix para uma chave Pix
   • Pagar um BR Code Pix
   • Transferir via TED
   • Transferência interna entre contas Stone

Saldo e Extrato 📄

Além das movimentações financeiras, você também pode gerir seu saldo e seu extrato para acompanhar o histórico de movimentações da sua conta. Para isso você pode consultar os seguintes endpoints:

1. Visualizar o saldo da conta;
2. Visualizar o histórico de transações in e out da conta

As demais operações financeiras disponíveis podem ser integradas de acordo com a prioridade do cliente, pois não existe um fluxo de interdependência entre elas. Tudo depende de como o parceiro vai integrar os serviços financeiros em seus modelos de negócio.

Produção 🚀

Depois de realizar os processos de integração necessários para validar seu modelo de negócio, chegou a hora de ir para o ar!

Para que a sua aplicação financeira vá para o ar, é necessário que ela passe por um processo de homologação. Durante o processo, a aplicação e consequentemente suas integrações serão validadas em ambiente de teste. Com um resultado positivo, será criado um novo ambiente de produção, com o qual você deverá novamente criar chaves de API para produção e configurar as medidas de segurança.

Gerenciamento da Integração 💻

Após a liberação de produção, é necessário que o parceiro gerencie a saúde de sua integração, bem como o atendimento primário de quaisquer questões que relacionem os serviços financeiros ao seu modelo de negócios. Para isso, na Plataforma de Gerenciamento Bancário é possível monitorar as contas abertas, status de transações, gerenciar membros e permissões para diferentes operadores e administradores de sua estrutura de customer success e atender as necessidades imediatas dos seus usuários finais sem nenhuma necessidade de realizar chamadas ou depender de desenvolvedores.

Caso tenha alguma dúvida sobre qualquer uma das etapas, consulte nossos canais de suporte na página de Tech suporte.