Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fernandospr/sdk-android-v2

SDK de FrontEnd para Gateway de pago Decidir
https://github.com/fernandospr/sdk-android-v2

Last synced: 5 days ago
JSON representation

SDK de FrontEnd para Gateway de pago Decidir

Awesome Lists containing this project

README 

        


Decidir SDK Android

===============



Modulo para conexión con gateway de pago DECIDIR2



+ [Introducción](#introduccion)

  + [Alcance](#scope)

  + [Diagrama de secuencia](#secuencia)

+ [Instalación](#instalacion)

  + [Versiones de Andrioid soportadas](#versionesdeandroidoportadas)

 + [Ambientes](#environments)

+ [Uso](#uso)

  + [Inicializar la clase correspondiente al conector](#initconector)

  + [Operatoria del Gateway](#operatoria)

    + [Generación de Token de Pago](#authenticate)

     +  [Con datos de tarjeta](#datostarjeta)

     +  [Con tarjeta tokenizada](#tokentarjeta)

  + [Integración con Cybersource](#cybersource)

     + [Device fingerprinter](#device)



## Introducción

El flujo de una transacción a través de las **sdks** consta de dos pasos, la **generación de un token de pago** por parte del cliente y el **procesamiento de pago** por parte del comercio. Existen sdks específicas para realizar estas funciones en distintos lenguajes que se detallan a continuación:



+ **Generación de un token de pago.**  Se utiliza alguna de las siguentes **sdks front-end** :

 + [sdk IOS](https://github.com/decidir/SDK-IOS.v2)

 + [sdk Android](https://github.com/decidir/SDK-Android.v2)

 + [sdk Javascript](https://github.com/decidir/sdk-javascript-v2)

+ **Procesamiento de pago.**  Se utiliza alguna de las siguentes **sdks back-end** :

 + [sdk Java](https://github.com/decidir/SDK-JAVA.v2)

 + [sdk PHP](https://github.com/decidir/SDK-PHP.v2)

 + [sdk .Net](https://github.com/decidir/SDK-.NET.v2)

 + [sdk Node](https://github.com/decidir/SDK-.NODE.v2)



[Volver a inicio](#inicio)





## Alcance

La **sdk Android** provee soporte para su **aplicación front-end**, encargandose de la **generación de un token de pago** por parte de un cliente. Este **token** debe ser enviado al comercio al realizar el pago.

Esta sdk permite la comunicación del cliente con la **API Decidir** utilizando su **API Key pública**1.



Para procesar el pago con **Decidir**, el comercio podr´ realizarlo a través de alguna de las siguentes **sdks front-backend**:

+ [sdk Java](https://github.com/decidir/SDK-JAVA.v2)

+ [sdk PHP](https://github.com/decidir/SDK-PHP.v2)

+ [sdk .Net](https://github.com/decidir/SDK-.NET.v2)

+ [sdk Node](https://github.com/decidir/SDK-.NODE.v2)



![imagen de sdks](./docs/img/DiagramaSDKs.png)



---

_1 - Las API Keys serán provistas por el equipo de Soporte de DECIDIR ([email protected]). _



[Volver a inicio](#inicio)






## Diagrama de secuencia

El flujo de una transacción a través de las **sdks** consta de dos pasos, a saber:



1. **sdk front-end:** Se realiza una solicitud de token de pago con la Llave de Acceso pública (public API Key), enviando los datos sensibles de la tarjeta (PAN, mes y año de expiración, código de seguridad, titular, y tipo y número de documento) y obteniéndose como resultado un token que permitirá realizar la transacción posterior.



2. **sdk back-end:** Se ejecuta el pago con la Llave de Acceso privada (private API Key), enviando el token generado en el Paso 1 más el identificador de la transacción a nivel comercio, el monto total, la moneda y la cantidad de cuotas.



A continuación, se presenta un diagrama con el Flujo de un Pago.



![imagen de configuracion](./docs/img/FlujoPago.png)



[Volver a inicio](#inicio)





## Instalación

Se debe descargar la última versión del SDK desde el botón Download ZIP del branch master.

Una vez descargado y descomprimido, se debe agregar la librería `decidir-sdk-android-release.aar` que se encuentra dentro de la carpeta`./decidir-sdk-android/build/outputs/aar`, a las librerías del proyecto y en el codigo se debe agregar siguiente import.



```java

import com.android.decidir.sdk.DecidirPaymentToken;

import com.android.decidir.sdk.dto.*;

import com.android.decidir.sdk.exceptions.*;

```





### Versiones de Android soportadas

La versión implementada de la SDK, está testeada para versiones desde API Level 14 (Android version >= 4.0)



[Volver a inicio](#inicio)






## Ambientes



La **sdk Android**  permite trabajar con los ambientes de Sandbox y Produccón de Decidir.

El ambiente se debe instanciar indicando su URL.



```java

import com.android.decidir.sdk.DecidirPaymentToken;



public class MiClase {

String publicApiKey = "92b71cf711ca41f78362a7134f87ff65";

String urlDesarrollo = "https://developers.decidir.com/api/v1";

String urlProduccion = "https://live.decidir.com/api/v1";

int timeout = 2; //Expresado en segundos

//Para el ambiente de desarrollo

DecidirPaymentToken decidirDesa = new DecidirPaymentToken(publicApiKey, urlDesarrollo, timeout);

//Para el ambiente de produccion

DecidirPaymentToken decidirProd = new DecidirPaymentToken(publicApiKey, urlProduccion, timeout);

// ...codigo...

}

```

[Volver a inicio](#inicio)





## Uso





### Inicializar la clase correspondiente al conector.



Instanciación de la clase `DecidirPaymentToken`



La misma recibe como parámetros la public key provista por Decidir para el comercio y el ambiente en que se trabajará.



La API Key será provista por el equipo de Soporte de DECIDIR ([email protected]).



```java

// ...codigo...

String publicApiKey = "92b71cf711ca41f78362a7134f87ff65";

//Para el ambiente de produccion(default) usando public api key

DecidirPaymentToken decidir = new DecidirPaymentToken(publicApiKey);

//...codigo...

```



[Volver a inicio](#inicio)






## Operatoria del Gateway






### Generación de Token de Pago



El SDK-Android permite generar, desde el dispositivo mobile, un token de pago con los datos de la tarjeta del cliente. Éste se deberá enviar luego al backend del comercio para realizar la transacción de pago correpondiente.



El token de pago puede ser generado de 3 formas como se muestra a continuación.



[Volver a inicio](#inicio)






#### Token para pagos Online



Mediante este recurso, se genera un token de pago a partir de los datos de la tarjeta del cliente.



|Campo | Descripcion  | Oblig | Restricciones  |Ejemplo   |

| ------------ | ------------ | ------------ | ------------ | ------------ |

| card_number| numero de tc  | SI  |  Mayor igual a 6 numeros   | "4507990000004905"  |

| card_expiration_month | mes de vto de tc  | SI  | No debe ser anterior a la fecha (mes/año) del dia actual  | 07  |

| card_expiration_year  |año de vto de tc   | SI  |  No debe ser anterior a la fecha (mes/año) del dia actual   | 17  |

| security_code | codigo de seguridad  | NO  | Sin validacion  | 234  |

| card_holder_name | titular (como figura en la tc)  | SI  | Mayor igual a 1 letra  | Valentin Santiago Gomez  |

| card_holder_identification.type  |  tipo de documento | NO  | Sin validacion  | dni/DNI, cuil/CUIL  |

| card_holder_identification.number  | nro de documento  | NO  |  Sin validacion | 23968498  |

| device_unique_identifier  | identificador único del dispositivo  | NO  |  Sin validacion | 12345  |

| card_holder_birthday  | fecha de nac. del titular  | NO  |  Date | Date  |

| card_holder_door_number  | numero de puerta del titular  | NO  |  Sin validacion | 10  |



```java

// ...codigo...

String publicApiKey = "92b71cf711ca41f78362a7134f87ff65";

//Para el ambiente de produccion(default) usando public api key

DecidirPaymentToken decidir = new DecidirPaymentToken(publicApiKey);

//Datos de tarjeta

PaymentToken datos = new PaymentToken();

datos.setCard_number("4509790112684851"); //Nro de ""tarjeta. MANDATORIO

datos.setSecurity_code("123"); // CVV. OPCIONAL

datos.setCard_expiration_month("03"); //Mes de vencimiento [01-12]. MANDATORIO

datos.setCard_expiration_year("19");//Año de vencimiento[00-99]. MANDATORIO

datos.setCard_holder_name("TITULAR"); //Nombre del titular tal como aparece en la tarjeta. MANDATORIO

datos.setCard_holder_birthday(new Date()); //Fecha de nac del titular. OPCIONAL

datos.setCard_holder_door_number(10); //Nro de puerta del titular. OPCIONAL



CardHolderIdentification idTitular = new CardHolderIdentification(); //Identificacion del titular de la tarjeta. Es opcional, pero debe estar completo si se agrega

idTitular.setType(IdentificationType.DNI);//MANDATORIO

idTitular.setNumber("12345678");//MANDATORIO

datos.setCard_holder_identification(idTitular); //OPCIONAL



//Datos para consumo de servicio

Context context = ... //Application context ( android.content.Context)

Boolean deteccionFraude = Boolean.TRUE; // Si se realiza deteccion de fraude por CyberSource

int timeoutFraude = 10; //Timeout para la solicitud de deteccion de fraude. Expresado en segundos. Por default es 30 segundos.



try {

  DecidirResponse respuesta = decidir.createPaymentToken(datos, context, deteccionFraude, timeoutFraude)

  // Procesamiento de respuesta de la generacion de token de pago

  // ...codigo...

} catch (DecidirException de) {

  // Manejo de excepcion  de Decidir

  // ...codigo...

} catch (Exception e) {

  //Manejo de excepcion general

  // ...codigo...

}

//...codigo...

```



[Volver a inicio](#inicio)






#### Token para pagos Online - con tarjeta tokenizada



Mediante este recurso, se genera un token de pago a partir una tarjeta tokenizada previamente.



```java

// ...codigo...

String publicApiKey = "92b71cf711ca41f78362a7134f87ff65";

//Para el ambiente de produccion(default) usando public api key

DecidirPaymentToken decidir = new DecidirPaymentToken(publicApiKey);

//Datos de tarjeta tokenizada

PaymentTokenWithCardToken datos = new PaymentTokenWithCardToken();

datos.setToken("f522e031-90cb-41ed-ba1f-46e813e8e789"); //Tarjeta tokenizada MANDATORIO

datos.setSecurity_code("123"); // CVV. OPCIONAL



//Datos para consumo de servicio

Context context = ... //Application context ( android.content.Context)

Boolean deteccionFraude = Boolean.TRUE; // Si se realiza deteccion de fraude por CyberSource

int timeoutFraude = 10; //Timeout para la solicitud de deteccion de fraude. Expresado en segundos. Por default es 30 segundos.



try {

DecidirResponse respuesta = decidir.createPaymentTokenWithCardToken(datos, context, deteccionFraude, timeoutFraude)

  // Procesamiento de respuesta de la generacion de token de pago

  // ...codigo...

} catch (DecidirException de) {

  // Manejo de excepcion  de Decidir

  // ...codigo...

} catch (Exception e) {

  //Manejo de excepcion general

  // ...codigo...

}

//...codigo...

```

[Volver a inicio](#inicio)



#### Token para pagos Offline



Mediante este recurso, se genera un token de pago a partir de los datos del cliente.



|Campo | Descripcion  | Oblig | Restricciones  |Ejemplo   |

| ------------ | ------------ | ------------ | ------------ | ------------ |

| customer. name | Nombre del cliente | SI  | Mayor igual a 1 letra  | Valentin Santiago Gomez  |

| customer.identification.type  |  tipo de documento | SI  | Sin validacion  | dni/DNI, cuil/CUIL  |

| customer.identification.number  | nro de documento  | SI  |  Sin validacion | 23968498  |



```java

// ...codigo...

String publicApiKey = "92b71cf711ca41f78362a7134f87ff65";

//Para el ambiente de produccion(default) usando public api key

DecidirPaymentToken decidir = new DecidirPaymentToken(publicApiKey);

//Datos de tarjeta tokenizada

OfflinePaymentToken datos = new OfflinePaymentToken();



Customer customer = new Customer(); //Identificacion del cliente.

customer.setName("Maxi");//MANDATORIO



CardHolderIdentification idTitular = new CardHolderIdentification(); //Identificacion del titular de la tarjeta. Es opcional, pero debe estar completo si se agrega

idTitular.setType(IdentificationType.DNI);//MANDATORIO

idTitular.setNumber("12345678");//MANDATORIO

customer.setIdentification(idTitular); //OPCIONAL



datos.setCustomer(customer);//MANDATORIO



try {

DecidirResponse respuesta = decidir.createOfflinePaymentToken(datos)

  // Procesamiento de respuesta de la generacion de token de pago

  // ...codigo...

} catch (DecidirException de) {

  // Manejo de excepcion  de Decidir

  // ...codigo...

} catch (Exception e) {

  //Manejo de excepcion general

  // ...codigo...

}

//...codigo...

```

[Volver a inicio](#inicio)






## Integración con Cybersource



Para utilizar el Servicio de Control de Fraude Cybersource, debe indicarse en un parámetro al momento de invocar el servicio de generación de token de pago.

[Ver ejemplo](#tokentarjeta)



[Volver a inicio](#inicio)




## Device FingerPrint

El **Device Fingerprint (DF)** es la huella digital del dispositivo que realiza la transacción. 

Es un dato muy importante que se tiene en cuenta en el proceso de validación

Para acceder a la documentación: 

https://decidir.api-docs.io/1.0/prevencion-de-fraude-by-cybersource/cs_device_fingerprint



[Volver a inicio](#inicio)