Librerías API (SDK)

Con el objetivo de facilitar la integración de la API Transferencia Bancaria PSD2, se proporciona una librería que facilita y simplifica la integración de la misma, de forma que sólo es necesario copiar y pegar unas sencillas líneas de código.

PHP

Descargar SDK PHP API PAYFLOW v1.0.8

Pago simple

Permite generar pagos en tiempo real con una cuenta bancaria de destino fija asociada al Cliente-Integrador, informada y validada en el Dashboard de Inespay. El enlace de pago emitido tiene una validez de 30 minutos desde que es generado.

Pago simple
            ------------
            <?php
            require_once('InespayApiPublic.php');

            $environmentApiInespay = InespayApiPublic::ENV_SAN; //Sandbox (pagos fictícios)
            //$environmentApiInespay = InespayApiPublic::ENV_PRO; //Producción (pagos reales)
            $apiKeyInespay = 'APIKEY API Transferencia Bancaria PSD2';
            $tokenInespay = 'TOKEN API Transferencia Bancaria PSD2';

            $apiInespay = new InespayApiPublic();
            $apiInespay->setEnvironmentInespay($environmentApiInespay);
            $apiInespay->setApiKeyInespay($apiKeyInespay);
            $apiInespay->setTokenInespay($tokenInespay);

            //Campos a rellenar dinámicamente
            $apiInespay->setSubject('Prueba pago simple INESPAY');   //Concepto del pago
            $apiInespay->setAmount(1.99);                //Importe con 2 decimales separados por un punto
            $apiInespay->setReference('ID_2022_AP');     //Identificador interno del pago personalizable por el Cliente-Integrador  

            //Opcionales
            $apiInespay->setUrlOk('https://www.example.com/ok.php'); //Url retorno éxito
            $apiInespay->setUrlError('https://www.example.com/error.php'); //Url retorno error
            $apiInespay->setUrlNotif('https://www.example.com/notif.php'); //Url notificación (Callback)
            $apiInespay->setCustomData("Custom data personalizado");

            $response = $apiInespay->generateSimplePaymentUrl(); //Llamada síncrona API Transferencia Bancaria PSD2

            if ( $response->getStatusCode() == InespayApiPublic::STATUS_CODE_SUCCESS){
                //Éxito generación URL de pago firmada
                echo $response->getUrlSigned();
            }else{
                //Error generación URL
            }
            ?>
            

Notificación del Estado de la Transacción (Callback)

Verificación de la firma de los datos enviados por INESPAY para asegurar que la respuesta procede de INESPAY y no han sido alterados. Esta verificación se debe realizar siempre por el Cliente-Integrador de la API en su lado de servidor.

Notificación del Estado de la Transacción (Callback)
            -----------------------------------------------------
            <?php
            require_once('InespayApiPublic.php');

            $apiKeyInespay = 'APIKEY API Transferencia Bancaria PSD2';
            $apiInespay = new InespayApiPublic();
            $apiInespay->setApiKeyInespay($apiKeyInespay);

            //Params received in POST    
            if (!empty( $_POST )) {

                $apiInespay->setDataReturn($_POST['dataReturn']);
                $apiInespay->setSignatureDataReturn($_POST['signatureDataReturn']);

                    //Firma OK, la respuesta ha sido enviada por INESPAY
                    if ($apiInespay->isDataReturnValid()){
                        echo "<p>FIRMA OK, realizar tareas en el Cliente Final</p>";
                        echo "<p>status=".$apiInespay->getStatusFromDataReturn()."</p>";
                        echo "<p>description=".$apiInespay->getDescriptionFromDataReturn()."</p>";
                        echo "<p>amount=".$apiInespay->getAmountFromDataReturn()."</p>";
                        echo "<p>reference=".$apiInespay->getReferenceFromDataReturn()."</p>";
                        echo "<p>transactionId=".$apiInespay->getTransactionIdFromDataReturn()."</p>";
                        echo "<p>customData=".$apiInespay->getCustomDataFromDataReturn()."</p>";

                    } else {
                        echo "<p>FIRMA KO, firma inválida revise los parámetros</p>";
                    }
                }
            ?>
            

Pago periódico

Permite generar órdenes de pago periódicas. El enlace de pago emitido tiene una validez de 30 minutos desde que es generado.

Pago periódico
            ---------------
            <?php
            require_once('InespayApiPublic.php');

            $environmentApiInespay = InespayApiPublic::ENV_SAN; //Sandbox (pagos fictícios)
            //$environmentApiInespay = InespayApiPublic::ENV_PRO; //Producción (pagos reales)
            $apiKeyInespay = 'APIKEY API Transferencia Bancaria PSD2';
            $tokenInespay = 'TOKEN API Transferencia Bancaria PSD2';

            $apiInespay = new InespayApiPublic();
            $apiInespay->setEnvironmentInespay($environmentApiInespay);
            $apiInespay->setApiKeyInespay($apiKeyInespay);
            $apiInespay->setTokenInespay($tokenInespay);

            //Campos a rellenar dinámicamente
            $apiInespay->setSubject('Prueba pago periódico INESPAY');   //Concepto del pago
            $apiInespay->setAmount(1.10);                //Importe con 2 decimales separados por un punto
            $apiInespay->setReference('PE_2021_FO');     //Identificador interno del pago personalizable por el Cliente-Integrador
            $apiInespay->setFrequency('Monthly');    
            $apiInespay->setDebtorAccount('ES2501822200160201933547'); //Sanbox debtorAccount
            $apiInespay->setStartDate('2021-12-01');

            //Opcionales
            $apiInespay->setUrlOk('https://www.example.com/ok.php'); //Url retorno éxito
            $apiInespay->setUrlError('https://www.example.com/error.php'); //Url retorno error
            $apiInespay->setUrlNotif('https://www.example.com/notif.php'); //Url notificación (Callback)
            $apiInespay->setCustomData("Custom data personalizado");
            $apiInespay->setEndDate('2022-12-01');

            $response = $apiInespay->generatePeriodicPaymentUrl(); //Llamada síncrona API Transferencia Bancaria PSD2

            if ( $response->getStatusCode() == InespayApiPublic::STATUS_CODE_SUCCESS){
                //Éxito generación url de pago firmada
                echo $response->getUrlSigned();
            }else{
                //Error generación url
            }
            ?>
            

Cancelación pago periódico

Permite cancelar órdenes de pago periódicas que se han generado previamente con el servicio de Alta de Pagos Periódicos.

Cancelación pago periódico
            ---------------------------
            <?php
            require_once('InespayApiPublic.php');

            $environmentApiInespay = InespayApiPublic::ENV_SAN; //Sandbox (pagos fictícios)
            //$environmentApiInespay = InespayApiPublic::ENV_PRO; //Producción (pagos reales)
            $apiKeyInespay = 'APIKEY API Transferencia Bancaria PSD2';
            $tokenInespay = 'TOKEN API Transferencia Bancaria PSD2';

            $apiInespay = new InespayApiPublic();
            $apiInespay->setEnvironmentInespay($environmentApiInespay);
            $apiInespay->setApiKeyInespay($apiKeyInespay);
            $apiInespay->setTokenInespay($tokenInespay);

            //Campos a rellenar dinámicamente
            $apiInespay->setDebtId('XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX');
            $apiInespay->setReference('CP_2021_CANCEL'); 
            $response = $this->apiInespay->generateCancelPeriodicPaymentUrl(); //Llamada síncrona API Transferencia Bancaria PSD2

            //Opcionales
            $apiInespay->setUrlOk('https://www.example.com/ok.php'); //Url retorno éxito
            $apiInespay->setUrlError('https://www.example.com/error.php'); //Url retorno error
            $apiInespay->setUrlNotif('https://www.example.com/notif.php'); //Url notificación
            $apiInespay->setCustomData("Custom data personalizado");

            $response = $apiInespay->generateCancelPeriodicPaymentUrl(); //Llamada síncrona API Transferencia Bancaria PSD2

            if ( $response->getStatusCode() == InespayApiPublic::STATUS_CODE_SUCCESS){
                //Éxito generación url de pago firmada
                echo $response->getUrlSigned();
            }else{
                //Error generación url
            }
            ?>