mpesa php api

Bem-vindo à API M-PESA PHP

Este projeto tem como objetivo fornecer um invólucro PHP fácil de usar e atualizado para a API M-Pesa Mozambique.

Versão alvo da API M-Pesa: V1X

Instalação

Instale usando o compositor:

 composer require abdulmueid/mpesa

Uso

1. Carregue a configuração do arquivo.

    $ config =  abdulmueid  mpesa Config:: loadFromFile ( ' /path/to/config.php ' );

   Consulte o arquivo de configuração de amostra na pasta Exemplos.

2. Crie uma transação usando a configuração.

    $ transaction = new  abdulmueid  mpesa  Transaction ( $ config );

3. Execute operações da API e passe parâmetros apropriados.

   1. Inicie uma cobrança de pagamento C2B.

       $ c2b = $ transaction -> c2b (
          float $ amount ,
          string $ msisdn ,
          string $ reference ,
          string $ third_party_reference
      );

   2. Iniciar um pagamento B2C.

       $ b2c = $ transaction -> b2c (
          float $ amount ,
          string $ msisdn ,
          string $ reference ,
          string $ third_party_reference
      );

   3. Iniciar um pagamento B2B.

       $ b2b = $ transaction -> b2b (
           float $ amount ,
           string $ receiver_party_code ,
           string $ reference ,
           string $ third_party_reference
      );

   4. Iniciar uma reversão.

       $ reversal = $ transaction -> reversal (
          float $ amount ,  
          string $ transaction_id ,
          string $ third_party_reference
      );

   5. Consulte uma transação.

       $ query = $ transaction -> query (
          string $ query_reference ,
          string $ third_party_reference
      );

4. Verifique a resposta

   Todas as transações retornam o objeto TransactionResponse . O objeto tem os seguintes métodos públicos:

   1. getCode() - Retorna o código de resposta, ou seja, INS-0

   2. getDescription() - Retorna a descrição.

   3. getTransactionID() - Retorna o ID da transação.

   4. getConversationID() - Retorna o ID da conversa.

   5. getTransactionStatus() - Retorna o status da transação. Somente preenchido ao chamar a transação query() .

   6. getResponse() - Retorna o objeto JSON de resposta completa, conforme recebido dos servidores M -Pesa. Bom para depurar quaisquer problemas ou comportamentos sem documentos da API M-Pesa.

Em um cenário típico, o código para verificar se há transações bem -sucedidas deve ser o seguinte:

 $ c2b = $ transaction -> c2b (...);

if ( $ c2b -> getCode () === ' INS-0 ' ) {
    // Transaction Successful, Do something here
}

Teste

Este repositório fornece testes de unidade para validar os objetos e sua interação com M-Pesa.

Para executar testes,

1. Abra o arquivo phpunit.xml e adicione as credenciais/parâmetros necessitados, conforme fornecido pela M-Pesa.
2. Execute phpunit
3. Verifique o telefone para obter instruções de USSD para aprovar transações de teste.

Todos os testes usam 1MT como o valor do teste.

Licença

Esta biblioteca é lançada sob a licença do MIT. Consulte o arquivo de licença para obter detalhes.