readme

Author: JoseHCalderon

CHANGELOG.md

@@ -0,0 +1,6 @@
+### versión 1.0.1 - 27-12-2022
+* Add status code
+* Add encrypt RSA
+
+### versión 1.0.0 - 27-12-2022
+* Add Yape y Confirm Order

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 CULQI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,279 @@
+# Culqi-Net-Framework
+Nuestra Biblioteca NET FRAMEWORK oficial, es compatible con la v2.0 del Culqi API, con el cual tendrás la posibilidad de realizar cobros con tarjetas de débito y crédito, Yape, PagoEfectivo, billeteras móviles y Cuotéalo con solo unos simples pasos de configuración.
+
+Nuestra biblioteca te da la posibilidad de capturar el `status_code` de la solicitud HTTP que se realiza al API de Culqi, así como el `response` que contiene el cuerpo de la respuesta obtenida.
+
+## Requisitos
+
+- NET FrameWork 3.6+
+* Afiliate [aquí](https://afiliate.culqi.com/).
+* Si vas a realizar pruebas obtén tus llaves desde [aquí](https://integ-panel.culqi.com/#/registro), si vas a realizar transacciones reales obtén tus llaves desde [aquí](https://panel.culqi.com/#/registro).
+
+> Recuerda que para obtener tus llaves debes ingresar a tu CulqiPanel > Desarrollo > ***API Keys***.
+
+![alt tag](http://i.imgur.com/NhE6mS9.png)
+
+> Recuerda que las credenciales son enviadas al correo que registraste en el proceso de afiliación.
+
+* Para encriptar el payload debes generar un id y llave RSA  ingresando a CulqiPanel > Desarrollo  > RSA Keys.
+  
+## Instalación
+
+Ejecuta los siguientes comandos usando la consola de comandos NuGet:
+
+```bash
+Install-Package RestSharp
+Install-Package Newtonsoft.Json
+```
+
+
+## Configuracion
+
+Para empezar a enviar peticiones al API de Culqi debes configurar tu llave pública (pk), llave privada (sk). Para habilitar encriptación de payload debes configurar tu rsa_id y rsa_public_key.
+
+```cs
+security = new Security();
+security.public_key = "pk_test_e94078b9b248675d";
+security.secret_key = "sk_test_c2267b5b262745f0";
+security.rsa_id = "de35e120-e297-4b96-97ef-10a43423ddec";
+
+security.rsa_key = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDswQycch0x/7GZ0oFojkWCYv+gr5CyfBKXc3Izq+btIEMCrkDrIsz4Lnl5E3FSD7/htFn1oE84SaDKl5DgbNoev3pMC7MDDgdCFrHODOp7aXwjG8NaiCbiymyBglXyEN28hLvgHpvZmAn6KFo0lMGuKnz8HiuTfpBl6HpD6+02SQIDAQAB";
+
+```
+
+### Encriptar payload
+
+Para encriptar el payload necesitas agregar el parámetros que contiene tu id y llave RSA.
+
+Ejemplo
+
+```cs
+public HttpResponseMessage CreateTokenEncrypt()
+{
+	return new Token(security).Create(jsonData.JsonToken(), security.rsa_id, security.rsa_key);
+}
+```
+
+## Servicios
+
+### Crear Token
+
+Antes de crear un Cargo o Card es necesario crear un `token` de tarjeta. 
+Lo recomendable es generar los 'tokens' con [Culqi Checkout v4](https://docs.culqi.com/es/documentacion/checkout/v4/culqi-checkout/) o [Culqi JS v4](https://docs.culqi.com/es/documentacion/culqi-js/v4/culqi-js/) **debido a que es muy importante que los datos de tarjeta sean enviados desde el dispositivo de tus clientes directamente a los servidores de Culqi**, para no poner en riesgo los datos sensibles de la tarjeta de crédito/débito.
+
+> Recuerda que cuando interactúas directamente con el [API Token](https://apidocs.culqi.com/#tag/Tokens/operation/crear-token) necesitas cumplir la normativa de PCI DSS 3.2. Por ello, te pedimos que llenes el [formulario SAQ-D](https://listings.pcisecuritystandards.org/documents/SAQ_D_v3_Merchant.pdf) y lo envíes al buzón de riesgos Culqi.
+
+```cs
+Dictionary<string, object> token = new Dictionary<string, object>
+{
+	{"card_number", "4111111111111111"},
+	{"cvv", "123"},
+	{"expiration_month", 9},
+	{"expiration_year", 2020},
+	{"email", "[email protected]"}
+};
+HttpResponseMessage token_created = new Token(security).Create(token);
+```
+
+
+### Crear Cargo
+
+Crear un cargo significa cobrar una venta a una tarjeta. Para esto previamente deberías generar el  `token` y enviarlo en parámetro **source_id**.
+
+Los cargos pueden ser creados vía [API de cargo](https://apidocs.culqi.com/#tag/Cargos/operation/crear-cargo).
+
+```cs
+var json_token = JObject.Parse(token_created);
+
+Dictionary<string, object> metadata = new Dictionary<string, object>
+{
+	{"order_id", "777"}
+};
+
+Dictionary<string, object> charge = new Dictionary<string, object>
+{
+	{"amount", 1000},
+	{"capture", true},
+	{"currency_code", "PEN"},
+	{"description", "Venta de prueba"},
+	{"email", "[email protected]"},
+	{"installments", 0},
+	{"metadata", metadata},
+	{"source_id", (string)json_token["id"]}
+};
+
+HttpResponseMessage charge_created = new Charge(security).Create(charge);
+```
+
+### Crear Devolución
+
+Solicita la devolución de las compras de tus clientes (parcial o total) de forma gratuita a través del API y CulqiPanel. 
+
+Las devoluciones pueden ser creados vía [API de devolución](https://apidocs.culqi.com/#tag/Devoluciones/operation/crear-devolucion).
+
+```cs
+var json_charge = JObject.Parse(charge_created);
+
+Dictionary<string, object> refund = new Dictionary<string, object>
+{
+	{"amount", 500},
+	{"charge_id", (string)json_charge["id"]},
+	{"reason", "solicitud_comprador"}
+};
+
+HttpResponseMessage refund_created = Refund(security).Create(refund);
+```
+
+### Crear Cliente
+
+El **cliente** es un servicio que te permite guardar la información de tus clientes. Es un paso necesario para generar una [tarjeta](/es/documentacion/pagos-online/recurrencia/one-click/tarjetas).
+
+Los clientes pueden ser creados vía [API de cliente](https://apidocs.culqi.com/#tag/Clientes/operation/crear-cliente).
+
+```cs
+Dictionary<string, object> customer = new Dictionary<string, object>
+{
+	{"address", "Av Lima 123"},
+	{"address_city", "Lima"},
+	{"country_code", "PE"},
+	{"email", "test"+GetRandomString()+"@culqi.com"},
+	{"first_name", "Test"},
+	{"last_name", "Culqi"},
+	{"phone_number", 99004356}
+};
+
+HttpResponseMessage customer_created = new Customer(security).Create(customer);
+```
+
+### Crear Tarjeta
+
+La **tarjeta** es un servicio que te permite guardar la información de las tarjetas de crédito o débito de tus clientes para luego realizarles cargos one click o recurrentes (cargos posteriores sin que tus clientes vuelvan a ingresar los datos de su tarjeta).
+
+Las tarjetas pueden ser creadas vía [API de tarjeta](https://apidocs.culqi.com/#tag/Tarjetas/operation/crear-tarjeta).
+
+```cs
+Dictionary<string, object> card = new Dictionary<string, object>
+{
+	{"customer_id", (string)json_customer["id"]},
+	{"token_id", (string)json_token["id"]}
+};
+
+HttpResponseMessage card_created = new Card(security).Create(card);
+```
+
+### Crear Plan
+
+El plan es un servicio que te permite definir con qué frecuencia deseas realizar cobros a tus clientes.
+
+Un plan define el comportamiento de las suscripciones. Los planes pueden ser creados vía el [API de Plan](https://apidocs.culqi.com/#/planes#create) o desde el **CulqiPanel**.
+
+```cs
+Dictionary<string, object> metadata = new Dictionary<string, object>
+{
+	{"alias", "plan-test"}
+};
+
+Dictionary<string, object> plan = new Dictionary<string, object>
+{
+	{"amount", 10000},
+	{"currency_code", "PEN"},
+	{"interval", "dias"},
+	{"interval_count", 15},
+	{"limit", 2},
+	{"metadata", metadata},
+	{"name", "plan-culqi-"+GetRandomString()},
+	{"trial_days", 15}
+};
+
+HttpResponseMessage plan_created = new Plan(security).Create(plan);
+```
+
+### Crear Suscripción
+
+La suscripción es un servicio que asocia la tarjeta de un cliente con un plan establecido por el comercio.
+
+Las suscripciones pueden ser creadas vía [API de suscripción](https://apidocs.culqi.com/#tag/Suscripciones/operation/crear-suscripcion).
+
+```cs
+var json_plan = JObject.Parse(plan_created);
+var json_card = JObject.Parse(card_created);
+
+Dictionary<string, object> subscription = new Dictionary<string, object>
+{
+	{"card_id", (string)json_card["id"]},
+	{"plan_id", (string)json_plan["id"]}
+};
+
+string subscription_created = new Subscription(security).Create(subscription);
+```
+
+### Crear Orden
+
+Es un servicio que te permite generar una orden de pago para una compra potencial.
+La orden contiene la información necesaria para la venta y es usado por el sistema de **PagoEfectivo** para realizar los pagos diferidos.
+
+Las órdenes pueden ser creadas vía [API de orden](https://apidocs.culqi.com/#tag/Ordenes/operation/crear-orden).
+
+```cs
+ Dictionary<string, object> client_details = new Dictionary<string, object>
+	{
+		{"first_name", "Juan"},
+		{"last_name", "Diaz"},
+		{"email", "[email protected]"},
+		{"phone_number", "+51948747421"},
+
+	};
+
+Dictionary<string, object> order = new Dictionary<string, object>
+	{
+		{"amount", 1000},
+		{"currency_code", "PEN"},
+		{"description", "Venta de prueba"},
+		{"order_number", "pedido"+Convert.ToString(order)},
+		{"client_details", client_details},
+		{"expiration_date", secondsSinceEpoch},
+		{"confirm", true}
+
+	};
+
+HttpResponseMessage order_created = new Order(security).Create(order);
+```
+
+## Pruebas
+
+En la caperta **/Pruebas** econtraras ejemplo para crear un token, charge, plan, órdenes, card, suscupciones, etc.
+
+> Recuerda que si quieres probar tu integración, puedes utilizar nuestras [tarjetas de prueba.](https://docs.culqi.com/es/documentacion/pagos-online/tarjetas-de-prueba/)
+
+### Ejemplo Prueba Token
+
+```cs
+HttpResponseMessage data = culqiCRUD.CreateToken();
+var json_object = JObject.Parse(data.Content.ReadAsStringAsync().Result);
+Assert.AreEqual("token",(string)json_object["object"]);
+```
+
+### Ejemplo Prueba Cargo
+
+```cs
+ HttpResponseMessage data = culqiCRUD.CreateCharge();
+var json_object = JObject.Parse(data.Content.ReadAsStringAsync().Result);
+Assert.AreEqual("charge", (string)json_object["object"]);
+```
+
+## Documentación
+
+- [Referencia de Documentación](https://docs.culqi.com/)
+- [Referencia de API](https://apidocs.culqi.com/)
+- [Demo Checkout V4 + Culqi 3DS](https://github.com/culqi/culqi-netframework-demo-checkoutv4-culqi3ds)
+- [Wiki](https://github.com/culqi/culqi-net_framework/wiki)
+
+## Changelog
+
+Todos los cambios en las versiones de esta biblioteca están listados en [CHANGELOG.md](CHANGELOG.md).
+
+## Autor
+Team Culqi
+
+## Licencia
+El código fuente de culqi-net-framework está distribuido bajo MIT License, revisar el archivo LICENSE.