Crie sua conta PagBank

Antes de utilizar as APIs do PagBank você precisa criar uma conta PagBank. Todas as novas contas são alocadas ao ambiente Sandbox para permitir que você realize testes no ambiente de desenvolvimento. Portanto, não existe opção de criação de conta diretamente para o ambiente de produção.

Para obter uma conta associada ao ambiente de Produção, é necessário passar pelo processo de homologação da sua conta Sandbox. A seguir, você encontrará descrições detalhadas sobre como criar contas, realizar a homologação e obter os dados de acesso necessários.

SandBox

Os passos 2 e 3 do processo apresentado a seguir são exclusivos para a utilização das APIs de Transferência e Pix Bacen. Para as demais APIs os passos 2 e 3 podem ser desconsiderados.

  1. Para criar uma conta para o ambiente Sandbox utilize o portal de criação de contas do PagBank.
  2. Realize o processo do Connect challenge para obter um token de acesso para gerar seu certificado digital.
  3. Gere um Certificado Digital mTLS.

📘

Validade do certificado digital

Certificados digitais por padrão tem validade de 2 anos. No entanto, dependendo do integrador, esse período de validade pode variar.

Após a expiração do certificado digital, você deverar gerar um novo certificado.

Caso você gere um novo certificado digital antes da expiração da validade do certificado antigo, o certificado antigo será invalidado imediatamente.

  1. Crie uma aplicação utilizando a API Connect. Ao criar uma aplicação você irá obter os parâmetros de identificação da sua aplicação, client_id e account_id. Com essas informações você poderá pedir autorização aos seus usuários para executar ações em seu nome.
  2. Teste as APIs disponibilizadas pelo PagBank no ambiente Sandbox. Nessa etapa você deve se certificar que todos os processos estão ocorrendo conforme esperado. Depois, você pode passar para a etapa de homologação para obter a sua conta para o ambiente de Produção.

Produção

A utilização do ambiente de Produção depende da aprovação do processo de homologação. Depois da homologação, você deverá repetir parte dos passos realizados no ambiente sandbox para obter credenciais para o uso das APIs no ambiente de produção. Os passos para a utilização do ambiente de Produção são listados a seguir. Como para o ambiente Sandbox, os passos 2 e 3 do processo apresentado a seguir são exclusivos para a utilização das APIs de Transferência e Pix Bacen. Para as demais APIs os passos 2 e 3 podem ser desconsiderados.

  1. Solicite a homologação da sua conta. Para isso, acesse a página de homologação. Durante o processo de homologação, o time PagBank irá validar os logs relacionados a sua conexão e uso das APIs do PagBank. Se você for aprovado, terá sua conta liberada para o ambiente de Produção.
  2. Realize o processo do Connect challenge para obter um token de acesso para gerar seu certificado digital.
  3. Gere um Certificado Digital mTLS.
  4. Crie uma aplicação utilizando a API Connect. Ao criar uma aplicação você irá obter os parâmetros de identificação da sua aplicação, client_id e account_id. Com essas informações você poderá pedir autorização aos seus usuários para executar ações em seu nome.
  5. Utilize as APIs disponibilizadas pelo PagBank no ambiente de Produção. Para mais informações sobre as funcionalidades acesse Funcionalidades disponíveis.