Download the PHP package levicosta201/gerencianet-pix-sdk without Composer
On this page you can find all versions of the php package levicosta201/gerencianet-pix-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download levicosta201/gerencianet-pix-sdk
More information about levicosta201/gerencianet-pix-sdk
Files in levicosta201/gerencianet-pix-sdk
Package gerencianet-pix-sdk
Short Description Package to connect with PIX Api from Gerencianet
License mit
Informations about the package gerencianet-pix-sdk
Gerencianet PIX SDK
Essa API foi desenvolvida para facilitar a integração com a API do PIX da Gerencianet. Você pode isntalar em qualquer projeto via composer.
New Features!
- Autenticação
- Geração de cobrança
A medida que forem desenvolvidas novas features iremos adicionando aqui neste documento, a API será atualizada constantemente até que seja realizado a comunicação com todas as partes da API.
Requisítos Mínimos
Para utilizar este SDK você precisará de no mínimo:
- [PHP] - php: >=7.3
- [CURL] - Latest Version
- [COMPOSER] - Latest Version
Instalação
A instalação deste SDK é ralmente muito simples e você poderá fazer isso apenas com o comando abaixo.
Utilização
Utilizar este SDK também foi facilitado. Sabemos que o SDK da GN é simples de utilizar, porém foi feita uma organização para melhor compreesão e facilidade da emissão do PIX. Veja o exemplo abaixo:
Autenticação:
Antes de efetuar qualquer transação na API PIX da GN é preciso que você receba um token de autenticação, este token pode ser obtido por meio de ticket da própria GN.
A solicitação acima irá retornar um array com os seguintes dados:
Cobrança:
Após a autenticação você já possui o necessário para realizar uma cobrança, que poderá ser realizada da seguinte maneira:
Parâmetros
Função | Tipo | Descrição |
---|---|---|
setNameDebtor() | String | Deverá ser informado o nome de quem está REALIZANDO O PAGAMENTO do Pix |
setCpfCnpjDebtor() | String | Deverá ser informado o CPF/CNPJ de quem está REALIZANDO O PAGAMENTO do Pix. Sem pontos e sem traços |
setCepDebtor() | String | Deverá ser informado o CEP de quem está REALIZANDO O PAGAMENTO do Pix |
setCityDebtor() | String | Deverá ser informado a Cidade de quem está REALIZANDO O PAGAMENTO do Pix |
setFreeValue() | Bool | Deverá ser informado se o valor do pagamento é livre ou não |
setValue() | Float | Deverá ser informado o valor da cobrança do Pix |
setType() | Bool | Deverá ser informado se o QR Code será dinâmico ou estático |
setDescriptionService() | String | Deverá ser informado a descrição da cobrança |
setDimenQrCoode() | Integer | Deverá ser informado o tamanho da imagem do QR Code, o tamanho máximo é 256px |
setUniquePay() | Bool | Deverá ser informado se o QR Code poderá ser reutilizado |
setExpiresTimeQrCode() | Integer | Deverá ser informado o tempo de expiração do QR Code em Milisegundos |
setKeyPix() | String | Deverá informar a sua chave PIX cadastrada no GN sem pontos e sem traços |
setTokenType() | String | Deverá informar o tipo de token que a API retorna |
create() | Class | Executa a cobrança e retorna o array com os dados da cobrança |
Caso tenha sucesso na execução acima você deverá receber o seguinte retorno em forma de array
Listagem de Pix:
Após realizar a sua cobrança, você poderá listar e visualizar as cobranças recebidas, para isso faça da seguinte forma:
Parâmetros
Função | Tipo | Descrição |
---|---|---|
setInitDate() | DateTime | Deverá ser informado para saber qual o início do período da busca |
setEndDate() | DateTime | Deverá ser informado para saber qual o fim do período da busca |
setFilterCpf() | String | Deverá ser informado para filtrar PIX por um CPF específico |
setFilterCnpj() | String | Deverá ser informado para filtrar PIX por um CNPJ específico |
setPaginate() | Integer | Deverá ser informado para filtrar a paginação da Lista do PIX |
setItensPerPage() | Integer | Deverá ser informado para o retorno de quantos PIX serão exibidos por página |
Caso tenha sucesso na requisição você receberá o seguinte array:
Todos
- Lis PIX
- List PIX Cob
- Pix Webhook
- Cancel PIX
License
MIT
Free Software, Hell Yeah!
All versions of gerencianet-pix-sdk with dependencies
ext-curl Version *