mpesa php api

Bienvenido a M-Pesa PHP API

Este proyecto tiene como objetivo proporcionar un envoltorio PHP fácil de usar y actualizado para la API M-Pesa Mozambique.

Versión objetivo de M-Pesa API: V1x

Instalación

Instalar usando el compositor:

 composer require abdulmueid/mpesa

Uso

1. Cargue la configuración desde el archivo.

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

   Consulte el archivo de configuración de muestra en la carpeta de ejemplos.

2. Cree una transacción utilizando la configuración.

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

3. Ejecute las operaciones de API y pase los parámetros apropiados.

   1. Iniciar una recaudación de pagos C2B.

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

   2. Iniciar un pago B2C.

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

   3. Iniciar un pago B2B.

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

   4. Iniciar una inversión.

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

   5. Consulta una transacción.

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

4. Verifique la respuesta

   Todas las transacciones devuelven el objeto TransactionResponse . El objeto tiene los siguientes métodos públicos:

   1. getCode() - Devuelve el código de respuesta, es decir, INS-0

   2. getDescription() - Devuelve la descripción.

   3. getTransactionID() - Devuelve la ID de transacción.

   4. getConversationID() - Devuelve la identificación de conversación.

   5. getTransactionStatus() - Devuelve el estado de la transacción. Solo poblado al llamar a la transacción de query() .

   6. getResponse() - Devuelve el objeto JSON de respuesta completa como se recibe de los servidores M -PESA. Bueno para depurar cualquier problema o comportamiento indocumentado de la API M-PESA.

En un escenario típico, el código para verificar las transacciones exitosas debe ser el siguiente:

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

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

Pruebas

Este repositorio proporciona pruebas unitarias para validar los objetos y su interacción con M-PESA.

Para ejecutar pruebas,

1. Abra el archivo phpunit.xml y agregue las credenciales/parámetros requerir como suministrados por M-PESA.
2. Ejecutar phpunit
3. Verifique el teléfono para obtener indicaciones para el USSD para aprobar las transacciones de prueba.

Todas las pruebas usan 1MT como el monto de la prueba.

Licencia

Esta biblioteca se lanza bajo la licencia MIT. Consulte el archivo de licencia para obtener más detalles.