Overview
Sejam bem-vindos à seção de Referências da Stone OpenBank API.
Através da nossa API é possível ter funcionalidades de internet banking e de apps de banco no seu negócio!
O que é a Stone OpenBank API
Aqui na Stone a gente acredita não apenas que o cliente tem razão, mas que ele é a nossa razão. Somos fiéis defensores da competição e acreditamos que isso melhora o mercado como um todo, o que, por sua vez, melhora a vida da nossa razão.
Foi com base nesse sentimento pró-competição que montamos a Stone OpenBank API: a primeira API de Open Banking plugada diretamente no STR. A Conta Stone é a nossa oferta para clientes PJ e PF, tanto para aqueles que já pertencem a base da Stone Adquirente, como para aqueles que utilizam outras adquirentes e buscam uma nova forma de se relacionar com sua conta.
O Aplicativo da Conta Stone é mais um parceiro da Stone OpenBank API, usando exatamente os mesmos acessos e APIs descritos nesse documento. "Eat your own dogfood" aplicado na prática.
Assim como nós pudemos criar o nosso aplicativo de conta em cima dessa API, você pode fazer o mesmo ou integrar as funcionalidades de automação bancária no seu negócio.
O que oferecemos?
Com a API da Conta Stone você pode disponibilizar para os seus clientes:
- Consulta de saldos e extratos;
- Emissão de comprovantes;
- Envio e recebimento de transferências tanto de outras Contas Stone como de outros bancos via TED;
- Pagamento e emissão de boletos;
- Pagamento de concessionárias e tributos;
- Cadastro de contatos favorecidos para envio de transferências para outros bancos;
- Folha de Pagamento;
- Link de Pagamento (Em breve);
- Pix (Em breve).
Como funciona a integração?
Por enquanto, ainda não estamos realizando on-board de parceiros em auto-serviço. Por isso, todos os interessados em firmar parcerias devem entrar em contato com o nosso time de parcerias seguindo os seguintes passos:
- Preencha nosso formulário para receber as informações necessárias para utilizar nossa API em Sandbox.
A partir do preenchimento do formulário vamos registrar a sua Aplicação no nosso sistema e enviar as credenciais de acesso para o ambiente de Sandbox. Além disso, vamos também criar contas de pagamento em Sandbox para você e sua equipe poderem testar a integração.
- Teste nossas APIS em Sandbox à vontade e, quando estiver pronto, informe ao time de parcerias da Stone através do e-mail parcerias@openbank.stone.com.br.
O processo envolve algumas reuniões presenciais ou por vídeo para a gente entender o melhor modelo de parceria para o seu negócio.
- Após tudo integrado, vem a homologação.
A Stone, com a ajuda do parceiro, vai realizar testes na Aplicação ainda em Sandbox para garantir que tudo funciona conforme o esperado e que nenhum cliente vai ser prejudicado por bugs em Produção.
Todo o processo para realização do cadastro se encontra descrito detalhadamente aqui.
Como integrar com a API
Todos os processos e requerimentos para a utilização de nossa API se encontram descritros detalhadamente em nossa Documentação:
Quickstart
Faça a sua primeira movimentação financeira de teste seguindo esses três passos!
Ambientes da API
Como funcionam nossos ambientes de Sandbox e Produção.
A Conta Stone
Como funciona este novo produto da Stone, criado para devolver à cliente o controle de sua conta de pagamentos.
Modelos de Parceria
Como funcionam os principais modelos de parceria que oferecemos para aplicações que desejam integrar com a nossa API.
Aplicativos
O que são os aplicativos desenvolvidos pela Stone e por parceiros.
Cadastro da Aplicação
Passo a passo para obter acesso e conseguir se autenticar em nossa API de Sandbox.
Autenticação
Aqui você encontra todos os detalhes sobre o processo de se autenticar na nossa API.
Testando a API
Teste nossa API no ambiente de Sandbox para garantir que tudo funciona conforme o esperado e que nenhuma cliente vai ser prejudicada por bugs em Produção.
Consentimento
Descrição de todo o processo de como obter acesso às contas de pagamento de suas clientes.
Aprovação
Como o dono da conta permite que uma transação criada pelo parceiro seja realizada.
Webhooks
Como notificamos o sistema parceiro da ocorrência de eventos.
Boas Práticas
Como armazenar dados e realizar operações em nossa API de forma segura.