Primeiros passos

Para começar a utilizar as APIs do PagBank, é essencial compreender os processos de integração dos serviços disponíveis e os requisitos para sua utilização.

1. Explore os serviços disponíveis

Antes de iniciar o uso das APIs do PagBank, é recomendado que você se familiarize com todas as funções disponíveis. Acesse a página das APIs do PagBank para entender todas as funcionalidades disponíveis.

📘

Integração direta e de plataforma

O sistema do PagBank atende a dois tipos de usuários:

• Clientes diretos : Realizam vendas utilizando exclusivamente a API de Pedidos do PagBank, pois são os únicos recebedores no ambiente de desenvolvimento.
• Clientes de plataforma: Clientes de plataformas e marketplaces devem ser integrados obrigatoriamente à API Connect, uma vez que realizam ações em nome dos usuários. O uso da API Connect é necessário para que plataformas e marketplaces recebam autorização de seus usuários (vendedores) para receber informações e executar ações em nome deles. Devido a esse requisito adicional, o fluxo de utilização dos clientes de plataforma é um pouco mais complexo, uma vez que necessitam de tais autorizações extras para concluir ações com as APIs do PagBank.

2. Requisitos de uso

Antes de utilizar as APIs do PagBank, você precisa realizar o processo de integração. Para isso, você deve entender como criar uma conta e os requisitos de uso das APIs do PagBank:

• Criação e homologação de uma conta
• Ambientes disponíveis
• Token de autenticação
• Chaves públicas e de idempotência

3. Utilize os endpoints de teste

Após criar sua conta SandBox e compreender os requisitos de uso das APIs do PagBank, você pode explorar e testar cada um dos serviços disponíveis. A seguir você encontra os guias de uso de todas as soluções:

• Chaves públicas
• Connect
• Certificado digital
• Cadastro de clientes
• Pedidos e pagamentos (Order)
• Transferências
• Checkout
• Pagamentos Recorrentes
• Pagar com PagBank
• EDI

4. Teste sua integração

Para que você teste completamente a sua integração antes de colocá-la em produção, o PagBank disponibiliza o ambiente SandBox, além de cartões de teste e um simulador de transações. Acesse Testar integração para mais informações.

5. Homologação

Após você realizar os testes da sua integração e garantir que tudo esteja funcionando conforme esperado, é necessário realizar a homologação da sua aplicação. Acesse Solicitar homologação para obter informações de como realizar o processo.

📘

Codigos de status

As APIs do PagBank seguem o padrão RESTful. Assim, códigos de resposta HTTP padrão são utilizados para indicar o sucesso ou problemas durante uma requisição à API. Acesse a página de Códigos de status para visualizar uma lista completa dos códigos utilizados.