SDK > PHP | Payment Gateway

PHP

Il linguaggio PHP è un linguaggio open source definito server side: questo vuol dire che, a differenza di linguaggi come HTML, CSS o JavaScript che vengono interpretati prima dal browser, il codice PHP viene eseguito direttamente sul web server, in cui gli script formulano delle istruzioni HTML che vengono solo alla fine trasmesse al browser e quindi al visitatore.

Installazione

È possibile installare l'SDK Nexi per PHP tramite il comando composer:

Utilizzare poi il seguente comando per installare le dipendenze:

Configurazione

Per poter comunicare con il gateway è necessario creare un oggetto di configurazione che implementi l'interfaccia IConfiguration.

                                    class Config implements IConfiguration
{
    public function getGatewayBaseUrl(): string
    {
        return "https://stg-ta.nexigroup.com/api/phoenix-0.0/psp/api/v1"; // indirizzo ambiente di test
    }

    public function getApiKey(): string
    {
        return "<X-Api-Key>"; // inserire api-key
    }
}
                                

Una volta instanziato, quest'oggetto può richiamare il costruttore PaymentGatewayClient che istanzia l'oggetto che si occupa della gestione delle chiamate verso il gateway.

Esempio di utilizzo

Ottenuto l'oggetto indicato nella sezione precedente, è possibile procedere con le richieste verso il gateway. Di seguito un esempio di pagamento tramite la modalità Hosted Payment Page:

                                    <?php

$config = new Config();

$paymentGatewayClient = new PaymentGatewayClient($config);
 
$createHostedOrderRequest = new CreateHostedOrderRequest(); // creazione oggetto di chiamata per pagamento Hosted Payment Page

$createHostedOrderRequest->setOrder(new Order()); // creazione oggetto ordine
$createHostedOrderRequest->getOrder()->setOrderId("my-order-id"); // assegnazione identificativo all'ordine
$createHostedOrderRequest->getOrder()->setAmount(10); // assegnazione importo all'ordine
$createHostedOrderRequest->getOrder()->setCurrency("EUR"); // assegnazione divisa all'ordine

$createHostedOrderRequest->setPaymentSession(new PaymentSession()); // creazione oggetto sessione di pagamento
$createHostedOrderRequest->getPaymentSession()->setAmount("10");  // impostazione dell'importo per la sessione di pagamento
$createHostedOrderRequest->getPaymentSession()->setLanguage("ITA"); // impostazione lingua pagina di cassa
$createHostedOrderRequest->getPaymentSession()->setResultUrl("http://www.example.com/payments/result/"); // impostazione indirizzo di esito
$createHostedOrderRequest->getPaymentSession()->setCancelUrl("http://www.example.com/payments/cancel/"); // impostazione indirizzo di annullo
$createHostedOrderRequest->getPaymentSession()->setNotificationlUrl("http://www.example.com/payments/s2s-notify/"); // impostazione indirizzo di notifica

$createHostedOrderResponse = $paymentGatewayClient->createOrderForHostedPayment($createHostedOrderRequest); // inizializzazione pagamento

echo "HostedPage: " . $createHostedOrderResponse->getHostedPage() . "<br>SecurityToken: " . $createHostedOrderResponse->getSecurityToken(); // gestione risposta

?>

                                

Gli oggetti, così come i metodi "set" per l'impostazione dei parametri, prendono riferimento dall'API POST /orders/hpp. L'SDK è stato sviluppato mantenendo i nomi dei parametri uguali a quelli delle API del gateway, per facilitare e migliorare l'esperienza di utilizzo.

Elenco API

Di seguito l'elenco delle API XPay disponibili nell'SDK, accessibili attraverso le funzioni presenti nel file PaymentGatewayClient.php:

Hosted Payment Page (POST /orders/hpp)
Pay-By-Link (POST /orders/paybylink)
M.O.T.O. (POST /orders/moto)
Pagamento ricorrente (POST /orders/mit)
Elenco ordini (GET /orders)
Ricerca ordine (GET /orders/{orderId})
Elenco operazioni (GET /operations)
Ricerca operazioni (GET /operations/{operationId})
Storno (POST /operations/{operationId}/refunds)
Contabilizzazione (POST /operations/{operationId}/captures)
Annullo contabilizzazione (POST /operations/{operationId}/cancels)
Elenco metodi di pagamento (GET /payment_methods)
Verifica carta (POST /orders/card_verification)
Annullo link Pay-By-Link (POST /paybylink/{linkId}/cancels)
Ricerca contratti (GET /contracts/customers/{customerId})
Disattiva contratto (POST /contracts/{contractId}/deactivation)
3 Step Init (POST /orders/3steps/init)
3 Step Validation (POST /orders/3steps/validation)
3 Step Pagamento (POST /orders/3steps/payment)