Download the PHP package paggcerto/paggcerto-sdk-php without Composer

On this page you can find all versions of the php package paggcerto/paggcerto-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of paggcerto/paggcerto-sdk-php

Informations about the package paggcerto-sdk-php

Paggcerto SDK PHP v1.1.7

Home Image

O modo mais simples e fácil de integrar sua aplicação PHP com a Paggcerto.

Codacy Badge Codacy Badge Build Status

Sumário

Requisições

Para utilizar nosso SDK é necessário ter as seguintes requisições:

require

require-dev

Instalação

Para iniciar a instalação execute em seu shell:

Configurando a instalação

Sem auth

Por auth com credenciais

Por auth com hash

Exemplos de utilização

Conta do Titular

Criar conta

Este método é utilizado para o cadastro da conta do titular. Após a finalização deste cadastro, deve ser realizada a autenticação do titular da conta.

Configurar conta

Com a configuração da conta podem ser alteradas as seguintes informações:

Obter configurações da conta

Neste método são exibidas todas as informações do titular da conta.

Métodos complementares

São métodos de consulta, que apresentam informações complementares para a criação da autenticado.

Consultar tipos de empresa

Nesta consulta são retornados todos os tipos de empresa.

Consultar cidades

Com a utilização desta consulta são retornadas as informações a respeito das cidades que estão localizadas no estado informado no endpoint.

Consultar bancos

É retornada uma lista com informações a respeito das instituições financeiras.

Consultar ramo de atividade

Com a utilização desta consulta são retornadas as informações de todos os ramos de atividades.

Consultar medias de marketing

Ao utilizar esta consulta são retornadas as informações a respeito das medias de marketing, que possibilitaram o usuário conhecer a Paggcerto.

Autenticação

O primeiro passo após a realização do cadastro da conta do titular é realizar sua autenticação. Nesta etapa será gerado o token de acesso para se conectar com nosso SDK e assim realizar as requisições. O token de acesso é confidencial e recomendamos não compartilhá-lo em ambientes públicos ou com terceiros. A seguir estão descritos os métodos que são responsáveis pela autenticação.

Autenticar com credenciais

O objetivo da autenticação do usuário é ter como resultado a geração do Token de Acesso. O token gerado para o ambiente sandbox é diferente do token do ambiente de produção.

Autenticar com hash

A finalidade deste método é realizar a autenticação do usuário que foi cadastrado pelo titular da conta através do Hash que foi enviado ao e-mail desse usuário. Como resultado, é gerado o token temporário, que deve ser utilizado para Criar Nova Senha.

Autenticar com id do lojista a partir do parceiro

Através deste método, o parceiro gera o token para o lojista sem a necessidade de conhecer a sua senha, passando apenas o id do lojista que se deseja gerar o token.

Sem autenticação

Para acessar os métodos complementares não é necessário estar autenticado. Abaixo está o exemplo:

Gerenciamento dos perfis de usuários

O titular da conta pode configurar perfis de usuários para que outras pessoas possam realizar operações na conta do titular. O perfil determina quais funcionalidades (métodos ou recursos) os usuários podem ter acesso. Abaixo estão os exemplos para o gerenciamento destes perfis.

Cadastrar perfil

Atualizar perfil

Para atualizar o perfil é necessário informar o identificador único roleId do perfil desejado.

Listar perfis

Sem filtros

Com filtros

Pesquisar perfil

Este método é utilizado quando se deseja buscar um perfil específico, para isso o roleId do perfil deve ser informado.

Desativar perfil

O roleId deve ser informado para desativar o perfil.

Ativar perfil

Informar o roleId para ativar o perfil.

Remover perfil

Para remover um perfil deve ser informado o roleId.

Permissões dos perfis

Para que o usuário acesse as funcionalidades é necessário que ele esteja vinculado à um perfil e que este perfil tenha as devidas permissões.

Conceder permissão

Para conceder as permissões é necessário informar o roleId.

Revogar permissão

O roleId deve ser informado para remover a permissão.

Gerenciamento dos usuários

A seguir serão apresentados todos os métodos com funcionalidades para o gerenciamento dos usuários. Os usuários são pessoas que realizam operações em uma conta com a permissão do titular, é necessário que o usuário esteja associado a um perfil.

Cadastrar usuário

Com a utilização deste método um novo usuário é criado. Os usuários recém-criados receberão por e-mail o hash de autenticação, que será utilizado no método autenticar com Hash.

Para acessar esse método é necessário ter a seguinte permissão: account.users.edit

Atualizar usuário

Com a utilização deste método os dados do usuário serão atualizados, para isso é necessário informar o ID do usuário desejado.

Para ter acesso a esse método, é necessário ter a seguinte permissão: account.users.edit.

Listar usuários

O objetivo deste método é listar todos os usuários cadastrados.

Para ter acesso a esse método, é necessário ter a seguinte permissão: account.users.readonly

Sem filtros

Com filtros

Pesquisar usuário

Esse método deve ser utilizado quando se deseja pesquisar um usuário específico, para isso o ID do usuário deve ser informado.

Para ter acesso a esse método, é necessário ter a seguinte permissão: account.users.readonly

Desativar usuário

O ID deve ser informado para desativar o usuário.

Para ter acesso a esse método, é necessário ter a seguinte permissão: account.users.edit

Ativar usuário

Informar o ID para ativar o usuário.

Para ter acesso a esse método, é necessário ter a seguinte permissão: account.users.edit

Pagamentos

Pagamento com cartão

Pagamento com cartão pode ser realizado a vista ou parcelado, utilizando múltiplos cartões e com possibilidade de split de pagamento. Cada transação de cartão deve obedecer requisitos pré-determinados: validade, limite financeiro do cartão, nome do titular do cartão e código de segurança. Nesta seção são exibidos os métodos para sua utilização.

A tabela abaixo apresenta alguns cartões para a realização de testes em nosso ambiente sandbox. Neste ambiente o nome do titular, a data de validade e o cvv podem ser fictícios:

Bandeira Nº do cartão
AMEX 349881342411264
DINERSCLUB 30386724055675
ELO 6363693078504487
HIPERCARD 6062820640453968
MASTERCARD 5111925270937702
VISA 4929915748910899

Consultar bandeiras

Esse método retorna uma lista com todas as bandeiras aceitas pela Paggcerto e suas respectivas regras de processamento (expressões regulares).

Simular pagamento

Ao utilizar este método é calculado o valor que o titular irá receber de acordo com o valor cobrado para um pagamento com cartão.

Efetuar pagamento com cartão

Esse método permite que o usuário realize um pagamento utilizando um ou mais cartões. Quando o valor do pagamento não for atingido, ele pode ser continuado com novos cartões através do método Continuar Pagamento.

Em addCard devem ser inseridas as seguintes informações: Nome do titular impreso no cartão, número do cartão, mês da validade, ano da validade, valor cobrado (esse valor não pode ser inferior a R$ 1,00 para venda à vista ou inferior a R$ 5,00 para venda parcelada), CVV, número da parcelas, informar a modalidade da venda: credito (true) ou débito (false).

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Pagamento com pré-captura

Com a utilização desse método o usuário poderá realizar um pagamento pré-autorizado, ou seja, a autorização do pagamento será realizada de forma manual através do método Capturar Pagamento. Sendo assim, o valor informado será temporariamente bloqueado no cartão até que seja finalizada a autorização do pagamento. Para esse tipo de pagamento, o campo isAuthorizedSale estar com o valor true e deve ser informado a quantidade de dias limite para a captura do pagamento no campo setDaysLimitAuthorization. Se este campo não for informado e o isAuthorizedSale for true, será considerado a quantidade de 29 dias.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Continuar pagamento

A finalidade desse método é permitir que o usuário continue o pagamento que não foi finalizado (o valor do pagamento não foi atingido).

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Capturar pagamento

O objetivo desse método é permitir a captura manual de um pagamento em duas etapas:

Somente o titular possui acesso a esse método.

Enviar Comprovante

O objetivo deste método é enviar o comprovante da transação para o cliente.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Pagamento com boleto

Boleto é um título de cobrança que pode ser pago em qualquer instituição ou estabelecimento conveniado. Além de indicar a data de vencimento, podem conter informações sobre desconto e/ou acréscimo de multa e juros e outras instruções. Após a emissão do boleto e se o e-mail e/ou telefone celular do pagador for informado ele poderá receber notificações, essas notificações são enviadas a partir das 11 horas de acordo com o horário de Brasília.

A tabela a seguir apresenta as regras para o envio das notificações:

Notificação Regras Comunicação
Boleto à vencer A notificação é enviada 3 dias antes do dia do vencimento ou no mesmo dia da emissão, caso o boleto seja emitido em até 3 dias antes do vencimento Do titular para o pagador
Boleto vencido A notificação é enviada 1, 5 e 10 dias após vencimento Do titular para o pagador
Boleto pago A notificação é enviada no mesmo dia da liquidação do boleto (após o processamento do arquivo de retorno enviado pelo banco) Do titular para o pagador
Boleto cancelado A notificação é enviada no mesmo dia do cancelamento do boleto Do titular para o pagador
Boleto expirado A notificação é enviada na data do cancelamento (baixa automática) programada junto ao banco no momento do registro Do titular para o pagador

Efetuar pagamento com boleto

O ojetivo deste método é realizado o pagamento com boletos. Por meio dele pode ser gerado apenas um ou mais boletos (carnê).

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create

Conclusão do pagamento

Finalizar pagamento

Um pagamento é automaticamente finalizado quando a soma dos valores pagos atinge o valor esperado para o pagamento. Porém, também é possível finalizar um pagamento sem que a soma de todas as transações ou boletos pagos atingam o valor esperado para esse pagamento devido a:

Pagamentos podem ser concluídos utilizando outra forma de pagamento (dinheiro, cheque, entre outros);

A contratação do serviço pode ser cancelada, dessa forma os boletos futuros podem ser cancelados, porém, mantendo o que já foi pago.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Cancelamento

Cancelar pagamento

O cancelamento somente será efetuado se for possível cancelar todas as transações com cartão e todos os boletos. Transações com cartão somente podem ser canceladas se forem realizadas na mesma data do seu processamento. Boletos podem ser cancelados desde que estejam pendentes ou vencidos, desta forma, não é possível cancelar boletos que já foram pagos.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Cancelar transação do cartão

O cancelamento da transação do cartão somente será efetuado se for realizado na mesma data do seu processamento.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Cancelar boleto

O cancelamento do boleto somente será efetuado se seu pagamento estiver pendente.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.create.

Relatórios

Detalhes do pagamento

Este método deve ser utilizado para exibir todas as informações a respeito do pagamento desejado.

Para ter acesso a esse método, é necessário ter a seguinte permissão: payments.readonly

Gerenciar os recebedores

Cadastrar recebedor

A finalidade deste método é cadastrar os recebedores para split de pagamento. Somente o titular da conta pode cadastrar recebedores.

Atualizar recebedor

O objetivo deste método é atualizar as informações do recebedor especificado no endpoint. Somente o titular da conta pode atualizar recebedores.

Pesquisar recebedor

Esse método deve ser utilizado quando se deseja pesquisar um recebedor específico. Somente o titular da conta pode pesquisar recebedor.

Listar recebedores

O objetivo deste método é listar todos os recebedores cadastrados. Somente o titular da conta pode listar recebedores.

All versions of paggcerto-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
rmccue/requests Version >=1.0
smalot/pdfparser Version ^0.14.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package paggcerto/paggcerto-sdk-php contains the following files

Loading the files please wait ....