Add more detail about the features of this library

conekta · Mar 3, 2017 · 5f14720 · 5f14720
1 parent ca1446d
commit 5f14720
Showing 1 changed file with 208 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,8 @@ To get started, add the following to your Java code:
     import io.conekta;
 
 ## Usage
-```java    
+### Create a customer  
+```java
 Conekta.setApiKey("1tv5yJp3xnVZ7eK67m4h");
 JSONObject customerJSON = new JSONObject("{"
     + "'name': 'James Howlett', "
@@ -56,11 +57,216 @@ System.out.println(customer);
   created_at=1485908856,
   id=cus_2fwNt8hqeq2vsGZk2,
   email=thane@jelucan.org,
-  payment_sources={}
+  payment_methods={}
 }
+```
+### Create an order with a card charge
+
+```java
+JSONObject completeOrderJSON = new JSONObject("{" +
+        "'currency': 'mxn'," +
+        "'metadata': {" +
+        "    'test': true"+
+        "}," +
+        "'line_items': [{" +
+        "    'name': 'Box of Cohiba S1s'," +
+        "    'description': 'Imported From Mex.'," +
+        "    'unit_price': 35000," +
+        "    'quantity': 1," +
+        "    'tags': ['food', 'mexican food']," +
+        "    'type': 'physical'" +
+        "}]," +
+        "'customer_info': { " +
+        "    'name': 'John Constantine'," +
+        "    'phone': '+5213353319758'," +
+        "    'email': 'hola@hola.com'" +
+        "}," +
+        "'charges': [{" +
+        "    'payment_method': {" +
+        "        'type': 'card'," +
+        "        'token_id': 'tok_test_visa_4242'" +
+        "    }, " +
+        "    'amount': 35000" +
+        "}]" +
+        "}");
+
+Order completeOrder = Order.create(completeOrderJSON);
+
+System.out.println(completeOrder.charges.get(0));
+
+{
+  device_fingerprint=123456789abcdefghijkmnopqrstuv,
+  amount=35000,
+  livemode=false,
+  fee=1467,
+  created_at=1488302828,
+  description=Payment from order,
+  paid_at=1488302831,
+  currency=MXN,
+  id=58b5b2ecdba34d7988fdf95c,
+  customer_id=,
+  order_id=ord_2g6SGGQrB92zcbYxe,
+  payment_method={
+    last4=4242,
+    name=Jorge Lopez,
+    exp_month=12,
+    exp_year=19,
+    type=credit,
+    brand=visa,
+    auth_code=270292
+  },
+  object=charge,
+  status=paid
+}
+```
+
+### Create an order with an OXXO Pay charge
+```java
+JSONObject completeOrderJSON = new JSONObject("{" +
+        "'currency': 'mxn'," +
+        "'metadata': {" +
+        "    'test': true"+
+        "}," +
+        "'line_items': [{" +
+        "    'name': 'Box of Cohiba S1s'," +
+        "    'description': 'Imported From Mex.'," +
+        "    'unit_price': 35000," +
+        "    'quantity': 1," +
+        "    'tags': ['food', 'mexican food']," +
+        "    'type': 'physical'" +
+        "}]," +
+        "'customer_info': { " +
+        "    'name': 'John Constantine'," +
+        "    'phone': '+5213353319758'," +
+        "    'email': 'hola@hola.com'" +
+        "}," +
+        "'charges': [{" +
+        "    'payment_method': {" +
+        "        'type': 'oxxo_cash'" +
+        "    }, " +
+        "    'amount': 35000" +
+        "}]" +
+        "}");
+
+Order oxxoOrder = Order.create(completeOrderJSON);
+
+Charge charge = oxxoOrder.charges.get(0);
+
+OxxoPayment oxxoPayment = (OxxoPayment) charge.payment_method;
+
+{
+  reference=93345678901234,
+  expires_at=1491091200,
+  service_name=OxxoPay,
+  store_name=OXXO,
+  type=oxxo
+}
+```
+
+### Create an order with an SPEI charge
+```java
+JSONObject speiOrderJSON = new JSONObject("{" +
+        "'currency': 'mxn'," +
+        "'metadata': {" +
+        "    'test': true"+
+        "}," +
+        "'line_items': [{" +
+        "    'name': 'Box of Cohiba S1s'," +
+        "    'description': 'Imported From Mex.'," +
+        "    'unit_price': 35000," +
+        "    'quantity': 1," +
+        "    'tags': ['food', 'mexican food']," +
+        "    'type': 'physical'" +
+        "}]," +
+        "'customer_info': { " +
+        "    'name': 'John Constantine'," +
+        "    'phone': '+5213353319758'," +
+        "    'email': 'hola@hola.com'" +
+        "}," +
+        "'charges': [{" +
+        "    'payment_method': {" +
+        "        'type': 'spei'" +
+        "    }, " +
+        "    'amount': 35000" +
+        "}]" +
+        "}");
+
+Order speiOrder = Order.create(speiOrderJSON);
 
+Charge charge = speiOrder.charges.get(0);
+
+{
+  amount=35000,
+  livemode=false,
+  fee=928,
+  created_at=1488563958,
+  description=Payment from order,
+  currency=MXN,
+  id=58b9aef6dba34d2f30fe84c1,
+  customer_id=cus_GziCBxxQz9G2f30fe,
+  order_id=ord_2g7Ra7LQz9GziCBxx,
+  payment_method={
+    bank=STP,
+    type=spei,
+    clabe=646180111812345678
+  },
+  object=charge,
+  status=pending_payment
+}
 ```
+### Handle Errors
+```java
+JSONObject incompleteOrderJSON = new JSONObject("{" +
+        "'currency': 'mxn'," +
+        "'metadata': {" +
+        "    'test': true"+
+        "}," +
+        "'line_items': [{" +
+        "    'name': 'Box of Cohiba S1s'," +
+        "    'description': 'Imported From Mex.'," +
+        "    'unit_price': 35000," +
+        "    'quantity': 1," +
+        "    'tags': ['food', 'mexican food']," +
+        "    'type': 'physical'" +
+        "}]," +
+        "'customer_info': { " +
+        "    'name': 'John Constantine'," +
+        "    'phone': '+5213353319758'," +
+        "    'email': 'hola@hola.com'" +
+        "}," +
+        "'charges': [{" +
+        "    'amount': 35000" +
+        "}]" +
+        "}");
 
+try {
+   Order.create(incompleteOrderJSON);
+} catch (ErrorList e) {
+   System.out.println(e.details.get(0).message);
+}
+
+El parametro payment_method es requerido.
+```
+
+### Endpoints
+```java
+order.refund();
+order.delete();
+order.update();
+order.capture();
+order.createCharge();
+order.createDiscountLine();
+order.createLineItem();
+order.createShippingContact();
+order.createShippingLine();
+order.createTaxLine();
+
+
+customer.createShippingContact();
+customer.createPaymentSource();
+customer.createSubscription();
+customer.createCard();
+```
 ## Documentation
 
 Please see https://www.conekta.com/docs/api for up-to-date documentation.