Pagar com PagBank iOS SDK

Introdução

O Pagar com PagBank é o produto do PagSeguro que permite aos vendedores utilizar o app PagBank como método de pagamento no checkout do seu próprio aplicativo. Este produto confere mais segurança aos vendedores devido aos padrões de validação de conta e cartões de crédito, adotados pelo PagBank.

SDK

A SDK disponibiliza um botão de pagamentos que facilita a integração do Merchant, através de suas credenciais pode enviar os dados do seu pedido e nossa SDK irá realizar a integração com nossos serviços.

---

Como funciona

Conceitos

Segue alguns termos usados nessa documentação:

Integrador: O desenvolvedor que vai usar o SDK em seu projeto para que possa oferecer para seus clientes o pagamento usando o PagBank

Pagador: O usuário que quer comprar algo usando o app do Integrador

O integrador que tem interesse em oferecer pagamento via PagBank adiciona o SDK no seu projeto e com isso disponibiliza um botão no seu app que redireciona o pagamento para o app do PagBank via um deeplink. Dentro do app do PagBank o usuário seleciona a forma de pagamento e prossegue com o pagamento normalmente. Essa etapa dentro do app PagBank é invísivel para o integrador.

Pré-requisitos

Credenciais de Autenticação

As soluções públicas do PagSeguro requerem autenticação e através dela identificamos e autorizamos o integrador a utilizar nossas APIs e seus recursos, bem como eventuais configurações adicionais.

Primeiro passo: Ter uma conta PagSeguro

1. Para criar uma conta no nosso ambiente acesse o link

2. Logo depois realize o login no ambiente de Sandbox acesse o link

3. Depois da criação da conta e autenticação em Sandbox, você deve se encontrar nessa página acesse o link

4. Se os passos acima foram realizados com sucesso, você já tem uma conta em Sandbox pronta para realizar testes.

Segundo passo: Criar uma aplicação para utilizar o pagar com PagBank.

1. Para obter o token de sandbox, acesse nossa página de Sandbox.

2. Após realizar o login, localize o menu Perfis de Integração e clique em Vendedor. O token de sandbox estará disponível na seção Credenciais.

3. Com o token em mãos, já é possível criar uma aplicação em Sandbox acesse o link

4. Com a sua aplicação criada com sucesso em Sandbox, guarde o campo client_id que foi retornado na resposta do serviço, pois é com esse campo que iniciaremos os testes com a SDK.

---

Requisitos

• Xcode 13+
• iOS 11.0+

---

Instalação

CocoaPods

• Para realizar a instalação via CocoaPods

  Adicione as seguintes linhas no seu Podfile

  use_frameworks!
  pod 'PagPay', '~> 1.1.0'

Manual (.framework)

• Para integrar a biblioteca (SDK) em seu projeto, siga os passos abaixo.

1. Faça o download da versão mais recente da biblioteca.
2. Abra o projeto do seu aplicativo pelo Xcode.
3. Arraste o arquivo PagPay.framework para dentro do seu projeto. Selecione Copy itens if need, Created group, Add to target.

4. Selecione seu projeto no Project Navigator e em seguida, selecione seu targets no menu targets. Depois vá em frameworks, Libaries, and Embedded Content e garanta que seu framework esteja Embed & Sing

---

Manual (.xcframework)

• Para instalar o .xcframework manualmente:
  1. Faça o download da versão mais recente do .xcframework no repositório.
  2. Abra o projeto do seu aplicativo pelo Xcode.
  3. Arraste o arquivo PagPay.xcframework para dentro do seu projeto. Selecione Copy itens if need, Created group, Add to target.
  4. Selecione seu projeto no Project Navigator e em seguida, selecione seu targets no menu targets. Depois vá em frameworks, Libaries, and Embedded Content e garanta que seu framework esteja Embed & Sing

---

Ultilização

Saiba como utilizar o Pagar com PagBank no seu aplicativo iOS.

• Como usar os botões
• Como criar uma requisição de pagamento

---

Ambientes disponíveis

Temos dois ambientes disponíveis, um para realizar os testes de integração e o de produção.

⚠️ Para realizar a troca do ambiente, é só mudar o parâmetro no método redirectPagBank que é usado no momento da requisição

Ambiente	Parâmetro
Sandbox	pagPay.redirectPagBank(merchantInfo, paymentRequest, delegate: self, env: .SANDBOX)
Produção	pagPay.redirectPagBank(merchantInfo, paymentRequest, delegate: self, env: .PROD)

---

Simular pagamento no ambiente de integração

A SDK possui um método de callback chamado onSuccessToRedirect que é executado quando o redirecionamento para o aplicativo PagBank é realizado com sucesso. Esse método possui um parâmetro chamado deepLinkCode.

Trecho de código de exemplo do callback:

extension ViewController: PagPayRedirectProtocol {
    func onSuccessToRedirect(deepLinkCode: String) {
        print(deepLinkCode) // Usado para realizar a simulação do pagamento
    }
    
    func onErrorToRedirect(error: ApiError) {
    }
}

⚠️ Para mais detalhes de como simular um pagamento no ambiente de Sandbox acesse o link

ℹ️ Aplicativo com implementação de exemplo acesse o link

Verificação do status do pagamento

O PagSeguro poderá enviar notificações via webhook para seu ambiente sempre que um evento (uma mudança de status de transação) acontecer, possibilitando a automação de seus processos de gestão de vendas. Para que isso aconteça basta atribuir suas urls de notificação no atributo notificationUrls do objeto PaymentRequest

Para mais informações de qual payload é enviado via url de notificação acesse o link para mais informações.

---

Ambiente de Produção

Depois de todos os testes e validações realizados no ambiente de Sandbox, a sua integração com a SDK do pagar com PagBank está apta para transacionar em Produção.

Gerar token do ambiente de produção:

1. Para obter o token de produção acesse sua conta atráves do iBanking.
2. Após realizar o login, localize Vendas Online e clique em Integrações.
3. Clique em Gerar token, você receberá o token pelo e-mail.
4. Realize o mesmo procedimento de criação de uma aplicação que realizou em sandbox, porém, agora em produção.
5. Para mais informações acesse o link

Como realizar o estorno de um pagamento recebido?

1. Acessando o iBanking no link.
2. Você pode através do menu "Extratos e Relatórios"
3. Acessar a opção "Extrato de Transações" e identificar a transação que deseja realizar o estorno.
4. Ao acessar os detalhes da transação a opção de estorno estará disponível.

Para mais informações sobre outra forma de integração acesse nossa documentação

Licença

Copyright 2022 PagSeguro Internet LTDA.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.