Conceitos principais
São informações necessárias sobre a empresa ou usuário. É obrigatório para habilitar Integrações na plataforma. No momento, solicitamos:
Uma Integração representa uma conexão com uma API de um banco ou instituição financeira parceira. Cada Integração possui Serviços de Cash-in e/ou Cash-out, que podem ser habilitados de forma modular. Para habilitar uma Integração, é necessário adicionar KYC à sua Conta.
Possibilita a entrada do dinheiro de diversas maneiras diferentes. (e.g. Depósito via boleto, cartão de crédito)
Consulte a seção Cash-in para mais detalhes
Possibilita transferências instantâneas Peer-to-Peer (P2P) entre os usuários do sistema.
Consulte a seção Conta gráfica para mais detalhes
Possibilita a saída do dinheiro de diversas maneiras diferentes. (e.g. Saque via TED, pagamento de contas, recarga de celular)
Consulte a seção Cash-out para mais detalhes
A única forma de acessar a nossa API é através de um par de Credenciais. O par é composto de uma Chave de API (apiKey) e um Segredo (secret). Confira a seção de integração para detalhes técnicos.
Suas Credenciais não devem ser compartilhadas ou expostas indevidamente! Qualquer um que tenha acesso à elas poderá realizar Ações em seu nome. A seção de Segurança recomenda boas práticas e dicas importantes.
Um Ativo pode ser criado para representar valores físicos ou digitais que podem ser transferidos entre pessoas ou empresas. Ele possui uma Conta emissora, que é responsável pela sua emissão e destruição. Alguns exemplos:
Moedas fiduciárias (BRL, USD)
Moedas digitais
Pontos de um programa de fidelidade
Milhas
Títulos financeiros (ações, debêntures)
Commodities
Quando uma Integração é utilizada, o Ativo é emitido pela própria Swipe.
Uma Conta possui saldos de um ou mais Ativos. Ela é representada por um identificador único, pode ter Contas filhas e pode, ou não, ter um par de Credenciais que garante todo o acesso via API.
Na maioria das aplicações, Contas costumam representar os usuários ou empresas clientes da aplicação.
Abaixo dois exemplos de cenários possíveis no momento da criação das Contas:
Nesse cenário temos um emissor (instituição cliente da Swipe) que pode criar Contas para seus próprios clientes.
Esse é cenário um pouco mais avançado, em que uma Conta emissora (instituição cliente da Swipe) utiliza Contas para intermediários (PSPs, Gateways, Escrows, etc) e, assim, tanto o emissor, quanto os intermediários, podem criar Contas filhas para seus clientes.