watts25/naranja-payment-sdk

Naranja Ranty - Checkout SDK

0.1.4 2020-07-15 13:20 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• vlucas/phpdotenv: ^2.6

unlicense

• Naranja Engineering

• php
• rest
• api
• payments
• sdk
• openapi
• openapitools
• openapi-generator
• naranja

README

Requerimientos

• Composer
• PHP >=7.1
• PHP Extensions: curl | json | mbstring | dom

Instalación

# Creamos la carpeta para el sdk
mkdir sdk
# Ingresamos a la carpeta
cd sdk
# Descomprimimos el SDK
unzip php-checkout-sdk.zip
# Instalamos las dependencias en /vendor
composer install

Ejemplo de uso

El primer paso es crear un PaymentRequest que contiene toda la información del pago que queremos recibir:

<?php
// Importamos el SDK y las clases
require_once(__DIR__ . '/../../vendor/autoload.php');
require(__DIR__ . '/../../checkoutApi.php');

// Instanciamos la clase NaranjaCheckout
// Utilizamos el CLIENT_ID y CLIENT_SECRET provistos por Naranja
// En 'ENVIRONMENT', para las pruebas usamos 'sandbox' y para nuestro entorno productivo 'production'
// Tener en cuenta que el CLIENT_ID y el CLIENT_SECRET son distintos para sandbox y para producción

$naranjaCheckout = new NaranjaCheckout('CLIENT_ID','CLIENT_SECRET','ENVIROMENT');

// Definimos el primer producto
$product1 = new Naranja\CheckoutApi\Model\ProductItem();
$product1->setName('Veggies');
$product1->setDescription('Granja del sol');
$product1->setQuantity(2);

// Definimos unit_price
$unitPrice1 = new Naranja\CheckoutApi\Model\Amount();
$unitPrice1->setCurrency('ARS');
$unitPrice1->setValue('115');

// Agregamos el unitPrice al producto
$product1-> setUnitPrice($unitPrice1);

// Definimos el segundo producto
$product2 = new Naranja\CheckoutApi\Model\ProductItem();
$product2->setName('Croquetas');
$product2->setDescription('Granja del sol'); 
$product2->setQuantity(1);

// Definimos el unit price del segundo producto
$unitPrice2 = new Naranja\CheckoutApi\Model\Amount();
$unitPrice2->setCurrency('ARS');
$unitPrice2->setValue('115');

// Agregamos el unitPrice al producto
$product2->setUnitPrice($unitPrice2);

// Definimos el objeto transaccion
$transaction = new Naranja\CheckoutApi\Model\Transaction();

// Definimos el Amount
$amountTransaction = new Naranja\CheckoutApi\Model\Amount();
$amountTransaction->setCurrency('ARS'); 
$amountTransaction->setValue('345');

// Agregamos el objeto amount a la transaccion
$transaction->setAmount($amountTransaction);
$transaction->setSoftDescriptor('GOFRIZ CONGELADOS');
$transaction->setProducts([$product1, $product2]);

// Generamos el payment request
$paymentRequest = new Naranja\CheckoutApi\Model\PaymentRequest();
$paymentRequest->setPaymentType('web_checkout');
$paymentRequest->setAuthorizationMode('SALE');
$paymentRequest->setExternalPaymentId('123456789');
$paymentRequest->setTransactions([$transaction]);

// Definimos el Requests creation redirect
$requestsCreationRedirect = new Naranja\CheckoutApi\Model\RequestCreationRedirect();
$requestsCreationRedirect->setSuccessUrl('https://gofriz.com.ar/success');
$requestsCreationRedirect->setFailureUrl('https://gofriz.com.ar/failure');

// Agregamos el requests redirect al paymenRequests
$paymentRequest->setRequestCreationRedirect($requestsCreationRedirect);
$paymentRequest->setCallbackUrl('https://gofriz.com.ar/notification');

// Ejecutamos el metodo
$response = $naranjaCheckout->createPaymentRequest($paymentRequest);

// Transformamos el JSON a datos nativo de PHP
$response = json_decode($response, true);

print_r($response['checkout_url'] . PHP_EOL);

Luego, para recibir las notificaciones, debemos implementar un endpoint que las reciba (que debe ser el mismo que especificamos en $paymentRequest->setCallbackUrl):

<?php
// Importamos el SDK y las clases
require_once(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../checkoutApi.php');

// Instanciamos la clase de NaranjaCheckout
$naranjaCheckout = new NaranjaCheckout('CLIENT_ID','CLIENT_SECRET','ENVIROMENT');

// Las notificaciones sobre el pago llegan via POST
// Por lo tanto solo nos preocupamos por ese verbo http
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
    // El id del pago llega via request body
    $body = json_decode(file_get_contents('php://input'), true);

    // Solicitamos los detalles del pago
    $payment = $naranjaCheckout->getPayment($body['id']);

    // Mostrar los detalles del pago
    $payment = $payment->__toString();
    print_r($payment);
}
?>

Pruebas

Para probar el flujo de checkout, una vez en el webform te vamos a pedir que te loguees. Tenemos dos usuarios de prueba que podes usar para los distintos escenarios:

• Éxito: [e-mail]
• Falla: [e-mail] Para ambos, el password es checkout123

API

Clase

class NaranjaCheckout(string $client_id, string $client_secret, string $environment);

• client_id: El id del cliente
• client_secret: El secreto del cliente
• environment: El ambiente que deseamos utilizar ( sandbox | prod )

Métodos

createPaymentRequest

Se utiliza para crear el paymentRequest

createPaymentRequest($paymentRequestInfo);

• paymentRequestInfo: Modelo instanciado de Naranja\CheckoutApi\Model\PaymentRequest

getPaymentRequest

getPaymentRequest(string $id);

• id: ID del payment request a checkear

getPaymentByExternalId

getPaymentByExternalId(string $external_payment_id);

• external_payment_id: ID externa configurada al crear el payment request

getPayment

getPayment(string $id);

• id: ID del payment a checkear

Modelos

Naranja\CheckoutApi\Model\PaymentRequest()

Métodos

setPaymentType( string )

Tipo de pago. Sólo permite "web_checkout".

setAuthorizationMode( string )

Modo de autorización. Sólo permite "SALE".

setExternalPaymentId( string )

Un id externo, para que el vendedor pueda identificar la venta.

setTransactions( [ Naranja\CheckoutApi\Model\Transaction() ] )

Por más que haya una sola transacción debemos pasar un array.

setAdditionalInfo( string ) [optional]

Información adicional.

setSellerData( Naranja\CheckoutApi\Model\SellerData() ) [optional]

Representa los datos del vendedor

setRequestCreationRedirect( Naranja\CheckoutApi\Model\RequestCreationRedirect() )

URLs a las cuales redirigir al usuario cuando termina el proceso del checkout.

setCallbackUrl( string )

URL a la cual enviar notficaciones sobre el estado de la transacción.

Naranja\CheckoutApi\Model\ProductItem()[optional]

Representa un ítem en la compra.

Métodos

setName( string )

Nombre del producto.

setDescription( string )

Descripción del producto.

setQuantity( int )

Cantidad de productos adquiridos.

setUnitPrice( Naranja\CheckoutApi\Model\Amount() )

Precio unitario del producto.

Naranja\CheckoutApi\Model\Amount()

Métodos

setCurrency( string )

Moneda en la cual se hizo la compra. Sólo admite "ARS".

setValue( string )

Valor de la compra.

Naranja\CheckoutApi\Model\Transaction()

Métodos

setAmount( Naranja\CheckoutApi\Model\Amount() )

Monto total de la transacción.

setSoftDescriptor( string )[optional]

Descripción con el cual queda registrado el consumo y como se ve en el resumen de cuenta.

setProducts( [ Naranja\CheckoutApi\Model\ProductItem() ] )

Los productos de la compra. Los mismos son sólo a título informativo para el cliente.

Naranja\CheckoutApi\Model\SellerData()

Métodos

setStoreId( string )

Identificador de la tienda

setSellerId( string )

Identificador del vendedor o comercio

setPosId( string )

Identificador del POS

setSystem( string )

Nombre del sistema del vendedor

setGeocode( string )

Código de geolocalización

setInvoiceData( string )

Datos discrecionales de la factura-ticket

Naranja\CheckoutApi\Model\RequestCreationRedirect()

Métodos

setSuccessUrl( string )

La URL a la cual enviamos al cliente cuando la transacción fue exitosa.

setFailureUrl( string )

La URL a la cual enviamos al cliente cuando la transacción falló.