O que é a API do PayPal
A API do PayPal é uma interface que atua como intermediária entre um servidor e um programa cliente. No nosso caso, o programa servidor que fornece API a desenvolvedores de terceiros é o PayPal. Um cliente é um programa criado pelos desenvolvedores com base na API do PayPal para efetuar pagamentos em um site, reembolsar vendas, consultar detalhes de transações, configurar um plano de cobrança, armazenar com segurança o histórico de cartões de crédito, etc. O PayPal é uma API REST; ela usa métodos HTTP para facilitar a integração em aplicações web e móveis.
Como obter a chave de API do PayPal, credenciais e assinatura
Lembre-se de que a integração com a API do PayPal está disponível apenas se você tiver uma conta PayPal Premier, Business ou Website Payments Pro. Primeiro, neste tutorial você precisará criar uma conta comercial.
Criar conta comercial no PayPal
PayPal.”>Passo 1. Cadastre-se no PayPal.
Passo 2. Primeiro, você precisará fornecer informações sobre si mesmo: seu nome, sobrenome, e-mail comercial e senha. Use uma senha exclusiva para sua conta PayPal e guarde-a com segurança. Se gerencia logins de negócios pelo celular, também é útil saber como encontrar senhas salvas no iPhone para recuperar o acesso caso seja necessário. senhas salvas no iPhone
Passo 3. Em seguida, informe os dados da empresa: razão social, telefone e endereço.
Fique atento: o PayPal está disponível em determinadas regiões e países ao redor do mundo.
São: Alberta, British Columbia, Manitoba, New Brunswick, NewFoundland and Labrador, Northwest Territories, Nova Scotia, Nunavut, Ontario, Prince Edward Island, Quebec, Saskatchewan, Yukon.
Se o seu negócio não pertencer a nenhuma dessas províncias, consulte as Perguntas Frequentes do PayPal para Desenvolvedores Internacionais. Em resumo, se você não for um desenvolvedor dos EUA ou do Reino Unido, pode usar as APIs NVP/SOAP deles.
Etapa 4. Além disso, selecione o tipo de negócio a partir das opções a seguir: Pessoa física, Empresário Individual, Sociedade Anônima (S.A.), Empresa Privada, Companhia Aberta, Organização sem fins lucrativos, Entidade governamental.
Em seguida, descreva seu negócio com mais detalhes e responda a várias perguntas:
Clique em “Enviar”. Em seguida, conte um pouco sobre você.
Passo 5. Em seguida, você precisará escolher o objetivo da sua conta PayPal. Você pode usá-la para receber ou enviar dinheiro, emitir faturas aos clientes ou oferecer o checkout com PayPal no site. Selecione Configurar Pagamentos Online. Agora você está a meio caminho de obter sua chave do PayPal.
Obter credenciais da API PayPal
Passo 1. Assim que criar uma conta empresarial, vá até a página de Desenvolvedor do PayPal e faça login no painel.
Passo 2. Depois de fazer login, você poderá obter uma chave de API pessoal do PayPal. Para isso, acesse a seção “My Apps & Credentials” e clique “Criar App”
Passo 3. Digite o nome do app e clique em “Criar” novamente. Você obterá um ID do Cliente, o nome de uma conta Sandbox e um “Segredo”.
Obter Assinatura da API PayPal ou Certificado
Nossa próxima etapa é gerar credenciais de Assinatura da API PayPal ou credenciais de Certificado da API. Se estiver em dúvida sobre qual escolher, veja abaixo a explicação das diferenças:
- Assinatura da API PayPal inclui Nome de Usuário da API, Senha da API e Assinatura, que não expiram.
- Credenciais do certificado da API incluem um Nome de usuário da API no PayPal, Senha da API e Certificado, que expiram automaticamente após três anos.
Lembre-se: para obter credenciais de API no PayPal, é necessário ter um endereço de e-mail verificado.
É assim que você obtém credenciais de Assinatura de API ou Certificado para a sua conta PayPal:
- Faça login na sua Conta Sandbox do PayPal, use os dados da sua conta empresarial.
- Clique no ícone “Configurações”.
- Clique em Acesso à Conta em “Conta e Segurança” no lado esquerdo da página.
- Na seção “Acesso à API”, clique em “Atualizar”.
- Clique em “Gerenciar credenciais da API” em “Integração da API NVP/SOAP”.
- Selecione uma das opções a seguir. Solicitar Assinatura da API – Selecione para autenticação por Assinatura da API. Solicitar Certificado da API – Selecione para autenticação por Certificado da API.
- Clique em “Concordo” e em “Enviar”.
- Isso é tudo! Depois disso, o PayPal gerará suas credenciais de API.
Exemplos de API PayPal
O PayPal oferece várias APIs REST e as divide em três categorias:
- Ao vivo – foram lançados recentemente, totalmente suportados e disponíveis para novos assinantes.
- Lançamento limitado – API totalmente suportada, disponível em mercados específicos.
- Obsoletas – APIs arquivadas, mas totalmente suportadas.
Confira abaixo os exemplos mais populares.
API de Pagamentos
Esse tipo de API é usado para enviar dinheiro para múltiplos destinatários do PayPal. É perfeito para quem quer enviar recompensas, reembolsos e comissões. Os destinatários precisarão informar o endereço de e-mail, o número de celular ou o Payer ID.
API REST de Pagamentos
O tipo de API mais difundido e funcional. É usado para aceitar pagamentos online com segurança e fluidez em sites e apps. Permite aceitar pagamentos imediatamente ou adiá-los, mostrar detalhes de transações concluídas, realizar reembolsos totais ou parciais.
API de Checkout Express do PayPal
Botões de pagamento inteligentes do PayPal oferecem aos usuários as opções de checkout mais relevantes, simples e seguras. Você pode personalizar facilmente os botões do PayPal, e há a possibilidade de adicionar métodos de pagamento alternativos, como Venmo ou cartão de crédito. Ao adicioná-lo ao seu site ou aplicativo, ele funciona da seguinte forma: primeiro, aparece uma janela pop-up de checkout que permite ao usuário fazer login no PayPal. Em seguida, após o comprador aprovar o pagamento, a PayPal Orders API finaliza a transação.
API de Assinaturas
Você pode iniciar pagamentos recorrentes via PayPal para itens físicos, serviços e também para produtos digitais. É possível definir um valor fixo a pagar e um plano com cobrança escalonada.
PayPal Disputes API
Caso haja algum problema, ocorrido no lado do PayPal, eles oferecem abrir uma disputa e entrar em contato com a equipe de suporte.
API de Pagamentos Recorrentes do PayPal
Este exemplo de API está obsoleto; a equipe do PayPal continua oferecendo suporte total aos comerciantes que ainda o utilizam. A API de pagamentos recorrentes é análoga à API de Assinaturas, mas oferece menos funcionalidades.
API de Faturas
Este exemplo de API está obsoleto, embora a equipe do PayPal ofereça suporte completo aos comerciantes que ainda o utilizam. A API de pagamentos recorrentes é análoga à API de Assinaturas, mas oferece menos funcionalidades. Para acompanhar os pagamentos de faturas, você pode usar webhooks — callbacks HTTP especiais que recebem mensagens de notificação de eventos.
O PayPal oferece um executor de API que permite aos desenvolvedores testar e integrar produtos antes do lançamento. Use-o para verificar o funcionamento de qualquer produto que você tenha escolhido.
Integração do PayPal em um site
Para adicionar um botão do PayPal a um site, você precisará iniciar fluxos de Engenharia e Negócios ao mesmo tempo.
Primeiro, crie sua própria solução de API, conforme descrito neste artigo. Em seguida, configure um sandbox para testar o produto (como desenvolvedor) e solicite uma conta Live. Uma conta Live integra todas as funcionalidades do PayPal. Integre e teste o produto que você criou. Depois que tudo estiver pronto, assine o contrato para obter a conta Live. Prepare tudo para ir ao vivo, verifique tudo com atenção e, por fim, lance sua solução baseada na API do PayPal!
Se você não quer perder tempo com todas essas etapas, aproveite o botão botão PayPal da Elfsight, personalizável, bonito e fácil de integrar. Basta criar uma conta empresarial no PayPal e já estar pronto para incorporar o botão em um site.
Um dos exemplos de API mais populares é o PayPal Express Checkout, que usa o método de integração NVP e SOAP. Ele está obsoleto, e embora o PayPal ainda o suporte, a API de Checkout mais recente oferece recursos novos e aprimorados.
Limites de API do PayPal e preços
Se você receber pagamentos via PayPal, haverá uma taxa percentual mais uma tarifa fixa, dependendo da moeda. Se você usar o PayPal, não precisará pagar taxas mensais nem taxas de rescisão em 2020. Abaixo, veja quanto custa usar o PayPal em vários países:
| Se o dinheiro que você receber vier de uma conta PayPal em: | Você deve pagar |
| Canadá | uma taxa de 2,9% do valor da transação, mais CAD 0,30 |
| EUA | uma taxa de 3,7% do valor da transação, mais US$ 0,30 |
| Europa | uma taxa de 3,9% do valor da transação, mais €0,35 EUR |
| Rússia | uma taxa de 3,9% do valor da transação, mais 10 RUB |
| Brasil | uma taxa de 3,9% do valor da transação mais 0,60 BRL |
| México | uma taxa de 3,9% do valor da transação, mais MXN 4,00. |
| Singapura | uma taxa de 3,9% do valor da transação mais SGD 0,50 |
Confira a lista completa de países e tarifas na página PayPal Payments Standard.
Falando sobre os limites diários de quantas vezes você pode chamar a PayPal API, é possível fazer quantas chamadas desejar. No entanto, recomendamos evitar chamadas excessivas à API.
Documentação do PayPal
Documentação da API PayPal é extremamente extensa, pois descreve os processos de pagamentos em todo o mundo. Para utilizá-la, você deve escolher um tipo de conta: Desenvolvedor, Pessoal ou Negócios. Em seguida, selecione o tipo de API que você gostaria de usar no projeto (já os listamos anteriormente). Em seguida, encontre uma página com o tipo de API necessário, estude os métodos e objetos oferecidos pela PayPal e, por fim, teste o que você obtém no Sandbox do desenvolvedor.
Alterações na API do PayPal
A PayPal desativou vários tipos de API, embora ainda os suporte. Familiarizar-se com as várias mudanças na API do PayPal pode ajudar a entender o processo de integração em um site.
2018 changes: Horizontal button layout started to be used by default; the code samples in the Payouts API Integration were updated; the recommended and default notations for the small Smart Payment Button were removed.
Mudança de 2019: Amostras de código foram adicionadas aos recursos de conversão de moeda, bem como uma lista de países excluídos.
Alteração de 2020: O gerenciamento de pagamentos recorrentes foi atualizado. Os usuários agora precisam criar pagamentos recorrentes, em vez de até 10 de uma vez.
FAQ
Devo me cadastrar como desenvolvedor se posso acessar o sandbox sem fazer login no site do desenvolvedor?
Não é necessário. Mas, se quiser ter acesso a recursos realmente legais, como criar uma conta de teste pré-configurada, acessar as credenciais da API REST e o painel de transações, faça isso.
É possível restaurar o histórico das minhas transações usando as APIs NVP/SOAP, se eu estiver usando a REST API no momento?
Infelizmente, não. Mas, especialmente para este caso, os desenvolvedores do PayPal apresentaram a API TransactionSearch.
Devo deixar as strings em branco se os valores forem opcionais?
O manipulador não deve ficar com strings vazias; se você não quiser preencher os campos opcionais, basta não adicioná-los.
Todas as APIs PayPal NVP/SOAP serão atualizadas para REST?
O PayPal está aprimorando seus serviços e as APIs NVP, da geração antiga, serão atualizadas em breve.
Conclusão
Ler toda a documentação do PayPal pode levar horas, pois você precisará organizar o processo de recebimento e venda de pagamentos pelo site ou app. Além disso, o PayPal está migrando das APIs antigas NVP/SOAP para a REST, o que significa o dobro de documentação em relação ao que havia antes.
Hoje, é possível colocar um Botão PayPal da Elfsight em um site de forma simples e personalizável, sem codificação e sem ler várias páginas de documentação. Basta cadastrar sua conta comercial em PayPal – o processo está em nosso tutorial – e criar o widget com funcionalidade incrível. Experimente agora!
