Licencia
API de pagos REST.
https://khipu.com/api/
https://khipu.com/api/2.0/banks
curl -i -X GET \
https://khipu.com/api/2.0/banks \
-H 'Authorization: YOUR_API_KEY_HERE'Operación exitosa. Devuelve un objeto JSON con el conjunto de bancos disponibles.
Arreglo con listado de bancos.
Mensaje con particularidades del banco.
Identificador del banco padre (si un banco tiene banca personas y empresas, el primero será el padre del segundo).
{ "banks": [ { "bank_id": "SDdGj", "name": "Banco Estado", "message": "Tarifa de $300 de transferencia a otros bancos, usando CuentaRUT.", "min_amount": 1000, "type": "Persona", "parent": "", "logo_url": "https://s3.amazonaws.com/static.khipu.com/logos/bancos/chile/estado-icon.png" } ] }
https://khipu.com/api/2.0/payments/{id}/confirm
curl -i -X POST \
'https://khipu.com/api/2.0/payments/{id}/confirm' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "message": "Message." }
https://khipu.com/api/2.0/payments/{id}
curl -i -X GET \
'https://khipu.com/api/2.0/payments/{id}' \
-H 'Authorization: YOUR_API_KEY_HERE'Operación exitosa. Devuelve un objeto JSON con la información de pago.
URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.
Arreglo de URLs de archivos adjuntos al pago.
Nombre del banco seleccionado por el pagador.
URL donde se redirige al pagador luego de que desiste hacer el pago.
Campo genérico que asigna el cobrador al momento de hacer el pago.
Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.
Origen de fondos usado por el pagador, puede ser debit para pago con débito, prepaid para pago con prepago, credit para pago con crédito, o vacío en el caso de que se haya pagado mediante transferencia bancaria.
Cadena de caracteres alfanuméricos que identifican unicamente al pago, es el identificador que el servidor de Khipu enviará al servidor del comercio cuando notifique que un pago está conciliado.
URL del webservice donde se notificará el pago.
Es true si la conciliación del pago fue hecha luego de la fecha de expiración.
Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).
Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada).
URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.
Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.
URL del comprobante de pago.
Correo electrónico de la persona responsable del pago.
URL donde se redirige al pagador luego que termina el pago.
Es true cuando Khipu enviará el cobro por correo electrónico.
Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios.
URL de pago simplificado.
Estado del pago, puede ser pending (el pagador aún no comienza a pagar), verifying (se está verificando el pago) o done, cuando el pago ya está confirmado.
Detalle del estado del pago: pending (el pagador aún no comienza a pagar), normal (el pago fue verificado y fue cancelado por algún medio de pago estándar), marked-paid-by-receiver (el cobrador marcó el cobro como pagado por otro medio), rejected-by-payer (el pagador declaró que no pagará), marked-as-abuse (el pagador declaró que no pagará y que el cobro fue no solicitado), y reversed (el pago fue anulado por el comercio, el dinero fue devuelto al pagador).
Identificador del pago asignado por el cobrador.
URL de pago normal.
{ "payment_id": "gqzdy6chjne9", "payment_url": "https://khipu.com/payment/info/gqzdy6chjne9", "simplified_transfer_url": "https://app.khipu.com/payment/simplified/gqzdy6chjne9", "transfer_url": "https://khipu.com/payment/manual/gqzdy6chjne9", "app_url": "khipu:///pos/gqzdy6chjne9", "ready_for_terminal": false, "notification_token": "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f", "receiver_id": 985101, "conciliation_date": "2017-03-01T13:00:00.000Z", "subject": "Test", "amount": 1000, "currency": "CLP", "status": "done", "status_detail": "normal", "body": "Test", "picture_url": "https://micomercio.com/picture_url", "receipt_url": "https://micomercio.com/order/receipt_url", "return_url": "https://micomercio.com/order/return_url", "cancel_url": "https://micomercio.com/order/cancel_url", "notify_url": "https://micomercio.com/webhook/notify_url", "notify_api_version": "3.0", "expires_date": "2023-12-31T15:45:00-04:00", "attachment_urls": [ "https://micomercio.com/attachment1.pdf" ], "bank": "Banco de Chile (Edwards Citi)", "bank_id": "dfFbF", "payer_name": "Nombre Pagador", "payer_email": "pagador@email.com", "personal_identifier": "11.000.111-9", "bank_account_number": "001120490689", "out_of_date_conciliation": true, "transaction_id": "zwo3wqz6uulcvajt", "custom": "<xml>...</xml>", "responsible_user_email": "responsible@email.com", "send_reminders": true, "send_email": true, "payment_method": "simplified_transfer", "funds_source": "debit", "discount": 0, "third_party_authorization_details": "" }
https://khipu.com/api/2.0/payments/{id}
curl -i -X DELETE \
'https://khipu.com/api/2.0/payments/{id}' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "message": "Message." }
https://khipu.com/api/2.0/payments
curl -i -X GET \
'https://khipu.com/api/2.0/payments?notification_token=string' \
-H 'Authorization: YOUR_API_KEY_HERE'Operación exitosa. Devuelve un objeto JSON con la información de pago.
URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.
Arreglo de URLs de archivos adjuntos al pago.
Nombre del banco seleccionado por el pagador.
URL donde se redirige al pagador luego de que desiste hacer el pago.
Campo genérico que asigna el cobrador al momento de hacer el pago.
Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.
Origen de fondos usado por el pagador, puede ser debit para pago con débito, prepaid para pago con prepago, credit para pago con crédito, o vacío en el caso de que se haya pagado mediante transferencia bancaria.
Cadena de caracteres alfanuméricos que identifican unicamente al pago, es el identificador que el servidor de Khipu enviará al servidor del comercio cuando notifique que un pago está conciliado.
URL del webservice donde se notificará el pago.
Es true si la conciliación del pago fue hecha luego de la fecha de expiración.
Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).
Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada).
URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.
Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.
URL del comprobante de pago.
Correo electrónico de la persona responsable del pago.
URL donde se redirige al pagador luego que termina el pago.
Es true cuando Khipu enviará el cobro por correo electrónico.
Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios.
URL de pago simplificado.
Estado del pago, puede ser pending (el pagador aún no comienza a pagar), verifying (se está verificando el pago) o done, cuando el pago ya está confirmado.
Detalle del estado del pago: pending (el pagador aún no comienza a pagar), normal (el pago fue verificado y fue cancelado por algún medio de pago estándar), marked-paid-by-receiver (el cobrador marcó el cobro como pagado por otro medio), rejected-by-payer (el pagador declaró que no pagará), marked-as-abuse (el pagador declaró que no pagará y que el cobro fue no solicitado), y reversed (el pago fue anulado por el comercio, el dinero fue devuelto al pagador).
Identificador del pago asignado por el cobrador.
URL de pago normal.
{ "payment_id": "gqzdy6chjne9", "payment_url": "https://khipu.com/payment/info/gqzdy6chjne9", "simplified_transfer_url": "https://app.khipu.com/payment/simplified/gqzdy6chjne9", "transfer_url": "https://khipu.com/payment/manual/gqzdy6chjne9", "app_url": "khipu:///pos/gqzdy6chjne9", "ready_for_terminal": false, "notification_token": "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f", "receiver_id": 985101, "conciliation_date": "2017-03-01T13:00:00.000Z", "subject": "Test", "amount": 1000, "currency": "CLP", "status": "done", "status_detail": "normal", "body": "Test", "picture_url": "https://micomercio.com/picture_url", "receipt_url": "https://micomercio.com/order/receipt_url", "return_url": "https://micomercio.com/order/return_url", "cancel_url": "https://micomercio.com/order/cancel_url", "notify_url": "https://micomercio.com/webhook/notify_url", "notify_api_version": "3.0", "expires_date": "2023-12-31T15:45:00-04:00", "attachment_urls": [ "https://micomercio.com/attachment1.pdf" ], "bank": "Banco de Chile (Edwards Citi)", "bank_id": "dfFbF", "payer_name": "Nombre Pagador", "payer_email": "pagador@email.com", "personal_identifier": "11.000.111-9", "bank_account_number": "001120490689", "out_of_date_conciliation": true, "transaction_id": "zwo3wqz6uulcvajt", "custom": "<xml>...</xml>", "responsible_user_email": "responsible@email.com", "send_reminders": true, "send_email": true, "payment_method": "simplified_transfer", "funds_source": "debit", "discount": 0, "third_party_authorization_details": "" }
El monto del cobro. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda.
El código de moneda en formato ISO-4217. Las monedas disponibles para pago dependerán del país configurado para el cobrador.
Identificador propio de la transacción. Ej: número de factura u orden de compra.
Parámetro para enviar información personalizada de la transacción. Ej: documento XML con el detalle del carro de compra.
La dirección URL a donde enviar al cliente mientras el pago está siendo verificado.
La dirección URL a donde enviar al cliente si decide no hacer hacer la transacción.
Una dirección URL de una foto de tu producto o servicio.
La dirección del web-service que utilizará khipu para notificar cuando el pago esté conciliado.
La dirección URL del archivo PDF con el contrato a firmar mediante este pago. El cobrador debe estar habilitado para este servicio y el campo fixed_payer_personal_identifier es obligatorio.
Versión de la API de notificaciones para recibir avisos por web-service.
Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.
Si es true, se enviará una solicitud de cobro al correo especificado en payer_email.
Nombre del pagador. Es obligatorio cuando send_email es true.
Correo del pagador. Es obligatorio cuando send_email es true.
Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro.
Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador.
Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada.
Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia.
Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601.
https://khipu.com/api/2.0/payments
curl -i -X POST \
https://khipu.com/api/2.0/payments \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d amount=1000 \
-d currency=CLP \
-d 'subject=Cobro de prueba'Operación exitosa. Devuelve un objeto JSON con la información del pago creado.
Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).
URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.
URL de pago simplificado.
URL de pago normal.
URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.
{ "payment_id": "gqzdy6chjne9", "payment_url": "https://khipu.com/payment/info/gqzdy6chjne9", "simplified_transfer_url": "https://app.khipu.com/payment/simplified/gqzdy6chjne9", "transfer_url": "https://khipu.com/payment/manual/gqzdy6chjne9", "app_url": "khipu:///pos/gqzdy6chjne9", "ready_for_terminal": false }
Es posible reembolsar el cobro hasta la 1:00 am del día habil siguiente. El cliente recibirá un correo electrónico explicándole que el comercio no ha podido completar la transacción y que los fondos serán devueltos a su cuenta bancaria. Esta operación solo se puede realizar en los comercios que recauden en cuenta Khipu.
https://khipu.com/api/2.0/payments/{id}/refunds
curl -i -X POST \
'https://khipu.com/api/2.0/payments/{id}/refunds' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'{ "message": "Message." }
Advertencia: Esta función sólo está disponible para los clientes que la hayan contratado de forma independiente. Para utilizarla, póngase en contacto con nosotros en soporte@khipu.com
Crear una nueva cuenta de cobro asociada a un integrador. Necesita datos de la cuenta de usuario asociada, datos de facturación y datos de contacto.
Nombre de pila del administrador de la cuenta de cobro a crear.
Apellido del administrador de la cuenta de cobro a crear.
Correo electrónico del administrador de la cuenta de cobro a crear.
Código alfanumérico de dos caracteres ISO 3166-1 del país de la cuenta de cobro a crear.
Identificador tributario del cobrador asociado a la cuenta de cobro a crear.
Categoría tributaria o rubro tributario del cobrador asociado a la cuenta de cobro a crear.
Nombre tributario del cobrador asociado a la cuenta de cobro a crear.
Teléfono del cobrador asociado a la cuenta de cobro a crear.
Dirección del cobrador de la cuenta de cobro a crear.
Segunda línea de la dirección del cobrador de la cuenta de cobro a crear.
Tercera línea de la dirección del cobrador de la cuenta de cobro a crear.
Nombre del contacto del cobrador.
Cargo del contacto del cobrador.
Correo electrónico del contacto del cobrador.
Teléfono del contacto del cobrador.
Tipo de cuenta. Es obligatorio si se utiliza el modelo alternativo de integrador de confianza.
Identificador personal del dueño de la cuenta de banco.
URL por omisión para el webservice donde se notificará el pago.
https://khipu.com/api/2.0/receivers
curl -i -X POST \
https://khipu.com/api/2.0/receivers \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d admin_first_name=Nombre \
-d admin_last_name=Apellido \
-d admin_email=admin@email.com \
-d country_code=CL \
-d business_identifier=99.999.999-9 \
-d 'business_category=VENTA AL POR MAYOR DE FRUTAS Y VERDURAS' \
-d 'business_name=Nombre Tributario' \
-d 'business_phone=+56988887777' \
-d 'business_address_line_1=Calle principal 1111' \
-d 'business_address_line_2=Oficina 3-A' \
-d business_address_line_3=Santiago \
-d 'contact_full_name=Nombre Contacto' \
-d contact_job_title=Tesorero \
-d contact_email=contacto@email.com \
-d 'contact_phone=+56955553333'{ "receiver_id": "934568", "secret": "b2025dc47a29a04592fa3c1191110370db0e208c" }
https://khipu.com/api/2.0/merchants/{id}/paymentMethods
curl -i -X GET \
'https://khipu.com/api/2.0/merchants/{id}/paymentMethods' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "paymentMethods": [ { "id": "simplified_transfer", "name": "simplified_transfer", "logo_url": "https://s3.amazonaws.com/static.khipu.com/buttons/2015/150x50-transparent.png" } ] }