PIXPDV SDK

O PIXPDV SDK é uma biblioteca que foi desenvolvida com o intuito de facilitar a integração dos seus aplicativos desenvolvidos em flutter com a API do PIXPDV.

Ao utilizar o PIXPDV SDK, você pode criar um QRCODE de pagamento seja ele dinâmicou ou até mesmo QRCODE de cobrança com data de Vencimento, valor, juros, multa, desconto e data de expiração. Você ainda pode consultar o status de um QRCODE específico, solicitar uma devolução consultar resumos e extratos.

Porque PIXPDV?

Por ser uma transferência eletrônica instantânea, em ambiente seguro, o PIXPDV se alinha ao ritmo do comércio e negócios em geral. Não há necessidade de esperar o próximo dia útil ou a próxima janela de horário para receber um pagamento. O PIXPDV funciona 24 horas, 7 dias por semana. Os custos são menores e há facilidade na integração com a conciliação de pagamentos. O PIXPDV na prática tem o mesmo efeito do pagamento em dinheiro (em espécie).

Como começar

Adicione o PIXPDV SDK como dependência no seu projeto, para isso, adicione a seguinte linha no seu arquivo pubspec.yaml:

Você deve adicionar o seguinte ao seu pubspec.yaml:

    dependencies:
        dio:
        pixpdv_sdk: ^0.0.1

Observação : se você estiver usando o canal Flutter master, se encontrar problemas de compilação ou quiser experimentar uma versão melhor e mais recente, utilize a versão mais atual apontando para a master e não uma versão de lançamento específica. Para fazer isso, use a seguinte configuração no seu pubspec.yaml:

    dependencies:
        pixpdv_sdk:
            git:
                url: #Utilize a URL do repositorio do github

Utilização

Para utilizar o PixPDV SDK, você deve seguir os seguintes passos:

Importando a Biblioteca

    import 'package:dio/dio.dart'; // Utilizamos o Dio para fazer as requisições HTTP
    import 'package:pixpdv_sdk/pixpdv_sdk.dart';

Criando a Instância do SDK

    import 'package:dio/dio.dart';
    import 'package:pixpdv_sdk/pixpdv_sdk.dart';

    // Crie uma Instância do Dio
    // Não é necessário passar o baseUrl, pois o SDK já faz isso automaticamente
    // com base no token informado e no ambiente de produção ou homologação

    Dio dio = Dio();

    // Crie uma Instância do Token
    // Você pode utilizar o token de produção ou de homologação

    // Usuário para testes em homologação
    String userName = '00641418000188';

    // Token de Homologação
    String password = 'tk-ezI0OTgwMzRDLUE1MzctNDM3QS1CQTk0LUZFODlFMEE0MzIyNn0';

    // Chave Secreta de Homologação
    String secretKey = 'sk-e0JBNTFGRTY0LTczMkYtNDYxNC1CQ0Q1LUI0OTVDODgxOTUwRX0';

    PixPDVTokenModel token = PixPDVTokenModel(
        enviroment: PixPDVEnviroment.homologacao,
        userName: userName,
        password: password,
        secretKey: secretKey,
    );

    // Crie uma Instância do SDK
    // Informe o Dio e o Token criados anteriormente

    pixPdvSdk = PixPdvSdk(
        dio: dio,
        token: token,
    );

    // Obs: Todo QRCode gerado no ambiente de homologação, independente do tempo de duração
    // sempre retornará o status CREATED

Tipos de Requisições

Tipo	Descrição
statustoken	Envia um json com o cnpj só para testar se as configurações estão corretas.
qrdinamico	Solicita um QRCode Dinâmico com valor e duração específicos.
qrcobranca	Solicita um QRCode cobrança com data de Vencimento, valor, juros, multa, desconto e data de expiração específicos.
qrstatus	Solicita o STATUS de um QRCode específico.
qrrefund	Solicita a devolução de um QRCode Dinâmico recebido anteriormente.
qrresumo	Solicita um RESUMO dos QRCodes de um período pelo Tipo de data.
saldo	Solicita o SALDO disponível na conta.
retirada	Retirar qualquer valor da conta e enviar para a instituição onde está a chave pix do cnpj.
extrato	Solicita o Extrato do período

Exemplos

Abaixo você pode ver alguns exemplos de como utilizar o SDK.

Para mais informações, acesse a documentação da API em PixPDV API.