Introdução a API de Cadastro

A API de Cadastro é uma ferramenta desenvolvida para os Parceiros PagBank que desejam criar contas em nome de seus clientes. Ela permite que os seus clientes criem uma nova conta PagBank ou se conectem a uma conta existente através da sua plataforma. É importante notar que a utilização da API de Cadastro para a criação de uma conta não é obrigatória. Você pode optar por redirecionar o usuário à página de criação de conta do PagBank como opção.

A conta criada é uma conta PagBank simples, que pode possibilita realizar transações. No entanto, para acessar e movimentar o saldo das vendas nessa conta, o titular precisará passar pelo processo de avanço de conta. Esse processo é realizado através do aplicativo PagBank, onde solicitações para cada etapa são apresentadas. Esse processo inclui o envio de uma foto do documento de identificação, tirar uma selfie e cadastrar uma senha.

Caso o seu cliente já tenha uma conta PagBank, não é necessário criar uma nova conta. Nesse caso, você deverá se conectar a essa conta existente utilizando a API Connect. Com a API Connect você irá criar uma aplicação que irá disponibilizar o client ID e o client secret. Isso irá permitir que você tenha a autorização do seu cliente para realizar ações em nome nos serviços do PagBank.

📘

Próximos passos após a criação da conta

É importante salientar que a utilização da API Connect para a obtenção do token de acesso (accessToken) após a criação da conta é um passo padrão para a utilização dos serviços do PagBank.

Recursos disponíveis e fluxo de uso

A API de Cadastro fornece dois endpoints, uma para Criar uma conta e outro para Consultar uma conta.

Criar conta

Para criar uma conta, você irá utilizar o endpoint Criar conta. Ao realizar a requisição ao endpoint, você deve definir o tipo de conta a ser criada. O PagBank disponibiliza dois tipos de conta:

  • BUYER - conta comprador, destináda exclusivamente a pessoas físicas.
  • SELLER: conta vendedor, criada para pessoa física ou jurídica e que possibilita realizar vendas. Esse tipo de conta é útil se você é um marketplace e está interessado em criar contas para seus vendedores.

Além do tipo de conta, outras informações devem ser informadas ao fazer requisição ao endpoint, como dados pessoais e dados de contato. O Objeto Account lista e descreve todos os possíveis campos que podem ser fornecidos ao endpoint Criar conta.

Ao criar uma conta do tipo SELLER, é necessário informar a categoria do negócio. A categoria de negócio corresponde à classificação do negócio dos usuários, sendo definida por um ENUM. Utilize o toogle abaixo para visualizar todas as categorias de negócio disponíveis.

Categorias de negócio
Categoria de negócio (ENUM) Descrição simplificada
BUTCHERY Açougue
LEGAL_SERVICE Advogados e Serviços Legais
TAILOR_AND_SEAMSTRESS Alfaiates / Costureiras
ITINERANT_SALE Ambulante
ARCHITECTURAL_AND_ENGINEERING Arquiteto e Engenheiro
ART_AND_ANTIQUE Arte e Antiguidades
RELIGION_AND_SPIRITUALITY Artigos Religiosos
VEHICLE_AND_PARTS Automóveis e Acessórios
BABY Bebês
VEHICLE_SERVICES Borracheiro / Mecânico / Funilaria / Pintura
BEAUTY_AND_BARBER Cabelereiro / Barbeiro / Manicure
BED_AND_BATH Cama, Mesa e Banho
TELECOMMUNICATION Celulares e Telefonia
KEY_CHAIN Chaveiro
PACKAGE_STORE Comércio de bebidas
FOOD_SERVICE Comida, Bebida e Nutricional
ADULT_CONTENT Conteúdo Adulto
REAL_ESTATE_AGENT Corretor de imobiliária
BROKER Corretor de seguro
DENTISTRY Dentista / Ortodontista
FREIGHT_FORWARDER Despachante
CANDIES_AND_CONFECTIONERIES Doces e confeitarias
HOUSEHOLD_APPLIANCE Eletrônicos / Eletrodomésticos
GENERAL_CONTRACTOR Empreiteiros Autônomos
GOVERNMENT Entidades Públicas
SPORT Esporte
HEALTH_AND_BEAUTY_SERVICE Esteticista / Massagista
NONDURABLE_GOODS Feira Livre
MEDICAL_SERVICE Fisioterapeutas / Fonoaudiólogos / Nutricionista / Psicólogo / Enfermeiros
PHOTOGRAPHY_AND_VIDEO Fotografia e gravação
SUPERMARKET Hipermercado / mercado / minimercado
LODGING Hospedagem e Turismo
FLORIST Jardineiro/Florista/Paisagista
JEWELRY_AND_WATCH Jóias e Relógios
OTHER_SERVICES Marceneiros / Serralheiros / Vidraceiros
DOCTOR Médicos em geral
FURNITURE_AND_DECORATION Móveis e Decoração
BAKERY Padaria
PERSONAL_TRAINER Personal Trainer
PET_SUPPLIES Pet Shop
PODIATRIST_AND_CHIROPODIST Podólogos / Pedicuros
REPAIR_SHOPS Reparos diversos
RESTAURANT Restaurantes e similares
CLOTHING_AND_ACCESSORIES Roupas e Acessórios
SHOE_STORE Sapateiro
EDUCATION Serviços de Educação
ENTERTAINMENT Serviços de recreação e lazer
PROFESSIONAL_SERVICE Serviços profissionais diversos
TATTOOIST Tatuadores
TRANSPORTATION_SERVICE Táxi - Autonomos
DOOR_TO_DOOR_SALES Vendas à Domicílio
VETERINARY_SERVICE Veterinários

Consultar conta

Para consultar uma conta, você irá utilizar o endpoint Consultar conta. Além do ID de identificação da conta (account_id) obtido no momento da criação da conta, você também deverá fornecer o token de acesso (accessToken) para consultar uma conta. O token de acesso é obtido através da API Connect e indica que o usuário lhe concedeu o direito a realizar ações em seu nome.

Erros

Ao utilizar os endpoints da API de Cadastro,você pode se deparar com erros associados à realização de requisições. Esses erros normalmente estão associados ao fornecimento incorreto de parâmetros ou à falta de autenticação. Para te auxiliar a entender os problemas ao executar as requisições, você pode acessar a página Códigos de erro, que lista os códigos que você pode receber e fornece detalhes adicionais para cada erro.

Restrições para a criação de contas

Para criar uma conta, é necessário seguir algumas regras de negócio. Primeiro, é preciso informar os dados mínimos obrigatórios no formato esperado, como nome, endereço, telefone e e-mail. Além disso, o titular da conta deve ser maior de 18 anos ou ter 16 anos ou mais e ser emancipado.

Uma etapa importante é a análise de KYC (conheça seu cliente), na qual os documentos do titular da conta são validados perante a Receita Federal. Isso garante que o titular esteja regularizado e em conformidade com as leis e regulamentos aplicáveis.

É fundamental que os dados informados correspondam exatamente aos dados presentes nos documentos de identificação do titular, como CPF (no caso de conta pessoal) ou ao cartão CNPJ (no caso de conta de pessoa jurídica). Essa correspondência é essencial para evitar erros de identificação e manter a integridade das informações fornecidas.

Ao seguir essas regras de negócio, é possível criar uma conta de forma adequada, atendendo aos requisitos estabelecidos e garantindo a conformidade com as normas aplicáveis.

Termos de uso e política de privacidade

Os Termos de Uso e a Política de Privacidade são documentos importantes que estabelecem as regras de uso e protegem a privacidade dos usuários. Ao criar uma conta, é necessário que o dono aceite esses termos, os quais definem direitos, responsabilidades e limitações. Os Termos de Uso estabelecem as bases legais e contratuais, enquanto a Política de Privacidade protege os dados pessoais dos usuários.

No momento da criação da conta, você deve solicitar o aceite ao usuário e registrar o IP e a data para segurança e auditoria. A seguir você encontra os links para acessar cada documento:

Teste a criação de uma conta

Para testar o processo de criação de contas, você irá utilizar o ambiente Sandbox. Todas as contas criadas no ambiente Sandbox são automaticamente aprovadas no KYC, uma vez que não é possível simular esse cenário.

Para que a conta seja criada com sucesso, você deve utilizar @sandbox.pagseguro.com.br como domínio de e-mail. Ao utilizar qualquer outro domínio, o processo de criação não será bem-sucedido.