Biblioteca JAVA para utilizar los servicios de Khipu.com
Versión Biblioteca: 1.2
Versión API Khipu: 1.2 Versión API de notificación: 1.2
La documentación de Khipu.com se puede ver desde aquí: https://khipu.com/page/api
Si usas Maven en tu proyecto puedes agregar la siguiente dependencia en tu archivo pom.xml
<dependency>
<groupId>com.khipu</groupId>
<artifactId>lib-khipu-1.4</artifactId>
<version>1.2.0</version>
</dependency>Si usas Ivy, Grape, Grails, Buildr, Scala SBT o quieres directamente bajar los .jar puedes buscar khipu en Maven Central.
Esta biblioteca implementa los siguientes servicios de khipu:
- Obtener listado de bancos
- Crear cobros y enviarlos por mail.
- Crear una página de Pago.
- Crear un pago y obtener us URL.
- Recibir y validar la notificación de un pago.
- Verificar el estado de una cuenta de cobro.
- Verificar el estado de un pago.
- Marcar un pago como pagado.
- Marcar un cobro como expirado.
- Marcar un pago como rechazado.
- Obtener listado de bancos.
Este servicio entrega un objteo KhipuReceiverBanksResponse que contiene un listado de los bancos disponibles para efectuar un pago a un cobrador determinado. Cada banco tiene su identificador, un nombre, el monto mínimo que se puede transferir desde él y un mensaje con información importante.
KhipuReceiverBanks receiverBanks = Khipu.getReceiverBanks(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
try {
KhipuReceiverBanksResponse response = (KhipuReceiverBanksResponse) receiverBanks.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Crear cobros y enviarlos por mail.
Este servicio entrega un objeto KhipuEmailResponse que contiene el identificador del cobro generado así como una lista de los pagos asociados a este cobro. Por cada pago se tiene el ID, el correo asociado y la URL en khipu para pagar.
KhipuCreateEmail createEmail = Khipu.getCreateEmail(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
createEmail.setSubject("Un cobro desde java");
createEmail.setExpiresDate(new Date(System.currentTimeMillis() + (30 * 24 * 60 * 60 * 1000)));
createEmail.addDestinatary("John Doe", "john.doe@gmail.com", 10);
createEmail.addDestinatary("Jane Dow", "jane.dow@gmail.com", 100);
createEmail.setSendEmails(true);
createEmail.setBody("Un cuerpo para este cobro");
try {
KhipuEmailResponse response = (KhipuEmailResponse) createEmail.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Crear una página de Pago.
Este ejemplo genera un archivo .html con un formulario de pago en khipu.
PrintWriter out;
try {
out = new PrintWriter("form.html");
out.print(Khipu.getPaymentButton(ID_DEL_COBRADOR
, SECRET_DEL_COBRADOR
, "john.doe@gmail.com"
, "ddd3f"
, "Prueba de cobro"
, "descripción de la prueba"
, 10
, "https://ejemplo.com/notify"
, "https://ejemplo.com/return"
, "https://ejemplo.com/cancel"
, "https://ejemplo.com/picture"
, "datos personalizados"
, "EEE87"
, Khipu.BUTTON_100x50));
out.close();
} catch (FileNotFoundException e) {
e.printStackTrace();
}- Crear un pago y obtener su URL.
Este servicio entrega un objeto KhipuUrlResponse para obtener que contiene el identificador de un pago generado, su URL en khipu y la URL para iniciar el pago desde un dispositivo móvil.
KhipuCreatePaymentURL createPaymentUrl = Khipu.getCreatePaymentURL(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
createPaymentUrl.setSubject("Un cobro desde java");
createPaymentUrl.setBody("Un cuerpo para este cobro");
createPaymentUrl.setEmail("john.doe@gmail.com");
createPaymentUrl.setAmount(1000);
try {
KhipuUrlResponse response = (KhipuUrlResponse) createPaymentUrl.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Validar la notificación de un pago.
Este ejemplo contacta a khipu para validar los datos de una transacción. Para usar este servicio no es necesario configurar el SECRET del cobrador. Se retorna un KhipuVerifyPaymentNotificationResponse cuyo método isVerified devuelve la validez de la información. En este ejemplo los parámetros se configuran a mano, pero en producción los datos deben obtenerse desde el HttpRequest.
Se debe notar que ID_DEL_COBRADOR_DESDE_EL_FORMULARIO es el receiver_id que envía khipu.
KhipuVerifyPaymentNotification verifyPaymentNotification = Khipu.getVerifyPaymentNotification(ID_DEL_COBRADOR);
verifyPaymentNotification.setPostReceiverId(ID_DEL_COBRADOR_DESDE_EL_FORMULARIO);
verifyPaymentNotification.setApiVersion("1.2");
verifyPaymentNotification.setNotificationId("wrj6iah3wssr");
verifyPaymentNotification.setSubject("Motivo de prueba");
verifyPaymentNotification.setAmount("17980");
verifyPaymentNotification.setCurrency("CLP");
verifyPaymentNotification.setTransaction_id("FTEEE5SWWO");
verifyPaymentNotification.setPayerEmail("john.doe@gmail.com");;
verifyPaymentNotification.setCustom("Custom info");
verifyPaymentNotification.setNotificationSignature("sU0HXc+eeQlTxrRw34M7APe+e3Mi2mllPEKw0rpIpRjJNvlNtPdVBtBmIE/2G0dakwpkjN3Q9fS8zYqjOLcW/Inbk8zXlmjM57IfRNy1PnW6S8qBWoNZPjBd0rXTjN5iMlCvLhNAX8vd34TZ9Z+XtcgLIUPjRzjyvf516DdmhVBwmcMy8fYDmjAVROHO4Gf/bVhirpLRqK7Tsf4XZm7p8jNzwM1JgrBZ5p/5ZwUxKzZo8ssTYAEPU5fU1Cog9daY3n80DprESqcWEIyhLpvXjI9ihNPxVJuHNFbntDpItBnqiMW9F21AQpOUZfeBGw337H6368nD8+uN5PC6hnoLw==");
try {
KhipuVerifyPaymentNotificationResponse response = (KhipuVerifyPaymentNotificationResponse) verifyPaymentNotification.execute();
System.out.println(response.isVerified());
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Verificar el estado de una cuenta de cobro.
Este servicio permite consultar el estado de una cuenta khipu. Se devuelve un KhipuReceiverStatusResponse que indica si esta cuenta está habilitada para cobrar y el tipo de cuenta (desarrollo o producción).
KhipuReceiverStatus receiverStatus = Khipu.getReceiverStatus(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
try {
KhipuReceiverStatusResponse response = (KhipuReceiverStatusResponse) receiverStatus.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Verificar el estado de un pago.
Este servició sirve para verificar el estado de un pago.
KhipuPaymentStatus paymentStatus = Khipu.getPaymentStatus(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
paymentStatus.setPaymentId("9fnsggqqi8ho");
try {
KhipuPaymentStatusResponse response = (KhipuPaymentStatusResponse) paymentStatus.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Marcar un cobro como pagado.
Este servicio permite marcar un cobro como pagado. Si el pagador paga por un método alternativo a khipu, el cobrador puede marcar este cobro como saldado.
KhipuSetPayedByReceiver setPayedByReceiver = Khipu.getSetPayedByReceiver(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
setPayedByReceiver.setPaymentId("54dhfsch6avd");
try {
KhipuSetPayedByReceiverResponse response = (KhipuSetPayedByReceiverResponse) setPayedByReceiver.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Marcar un cobro como expirado.
Este servicio permite adelantar la expiración del cobro. Se puede adjuntar un texto que será desplegado a la gente que trate de ir a pagar.
KhipuSetBillExpired setBillExpired = Khipu.getSetBillExpired(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
setBillExpired.setBillId("udmEe");
setBillExpired.setText("Plazo vencido");
try {
KhipuSetBillExpiredResponse response = (KhipuSetBillExpiredResponse) setBillExpired.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}- Marcar un cobro como rechazado.
Este servicio permite rechazar pago con el fin de inhabilitarlo. Permite indicar que el pagador rechaza saldar este pago:
KhipuSetRejectedByPayer setRejectedByPayer = Khipu.getSetRejectedByPayer(ID_DEL_COBRADOR, SECRET_DEL_COBRADOR);
setRejectedByPayer.setPaymentId("0pk7xfgocry4");
setRejectedByPayer.setText("El pago no corresponde");
try {
KhipuSetRejectedByPayerResponse response = (KhipuSetRejectedByPayerResponse) setRejectedByPayer.execute();
System.out.println(response);
} catch (KhipuException e) {
System.out.println(e.getType());
System.out.println(e.getMessage());
} catch (IOException e) {
e.printStackTrace();
}