Pagos Instantáneos

Get banks

API Pagos Instantáneos (v3.0)

La API Instant Payment de Khipu (versión 3.0) permite a comerciantes iniciar, consultar, confirmar, reembolsar o eliminar pagos inmediatos mediante transferencias bancarias en tiempo real. Entre sus principales funcionalidades se encuentran: obtener la lista de bancos disponibles con detalles como límites, tarifas y logos; crear un pago especificando un banco o dejar que el usuario elija; confirmar o solicitar el reembolso de un pago mediante su ID; y predecir el estado de un pago usando machine learning. Esta API maneja autenticación mediante clave secreta en el encabezado x-api-key, no requiere firmas, y utiliza certificados SSL de validación extendida para asegurar la comunicación

Download OpenAPI description

openapi.json

openapi.yaml

Overview

Licencia

API Pagos Instantáneos

Servers

Producción

https://payment-api.khipu.com/

Get banks

Request

Este método obtiene la lista de bancos que se pueden utilizar para pagar en esta cuenta de cobro.

Security

Api-Key

curl -i -X GET \
  https://payment-api.khipu.com/v3/banks \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa. Devuelve un objeto JSON con el conjunto de bancos disponibles.

Bodyapplication/json

banksArray of objectsnon-emptyrequerido

Arreglo con listado de bancos.

bank_idstringrequerido

Identificador del banco.

Ejemplo: "SDdGj"

namestringrequerido

Nombre del banco.

Ejemplo: "Banco Estado"

messagestringrequerido

Mensaje con particularidades del banco.

Ejemplo: "Tarifa de $300 de transferencia a otros bancos, usando CuentaRUT."

min_amountnumber(double)requerido

Monto mínimo que acepta el banco en un pago.

Ejemplo: 1000

typestringrequerido

Tipo de banco.

Enum"Persona""Empresa"

Ejemplo: "Persona"

parentstringrequerido

Identificador del banco padre (si un banco tiene banca personas y empresas, el primero será el padre del segundo).

Ejemplo: ""

logo_urlstring

URL del logo del banco.

Ejemplo: "https://s3.amazonaws.com/static.khipu.com/logos/bancos/chile/estado-icon.png"

Response

application/json

{
  "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"
    }
  ]
}

Confirm payment by Id

Request

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

Confirmar el pago. Al confirmar el pago, este será rendido al día hábil siguiente.

Security

Api-Key

Path

idstring<= 255 charactersrequerido

Identificador del pago

curl -i -X POST \
  'https://payment-api.khipu.com/v3/payments/{id}/confirm' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa.

Bodyapplication/json

messagestringrequerido

Mensaje a desplegar al usuario.

Ejemplo: "Message."

Response

application/json

{
  "message": "Message."
}

Get payment by Id

Request

Información completa del pago. Datos con los que fue creado y el estado actual del pago.

Security

Api-Key

Path

idstring<= 255 charactersrequerido

Identificador del pago

curl -i -X GET \
  'https://payment-api.khipu.com/v3/payments/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa. Devuelve un objeto JSON con la información de pago.

Bodyapplication/json

payment_idstringrequerido

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).

Ejemplo: "gqzdy6chjne9"

payment_urlstringrequerido

URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.

Ejemplo: "https://khipu.com/payment/info/gqzdy6chjne9"

simplified_transfer_urlstringrequerido

URL de pago simplificado.

Ejemplo: "https://app.khipu.com/payment/simplified/gqzdy6chjne9"

transfer_urlstringrequerido

URL de pago normal.

Ejemplo: "https://khipu.com/payment/manual/gqzdy6chjne9"

app_urlstringrequerido

URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.

Ejemplo: "khipu:///pos/gqzdy6chjne9"

ready_for_terminalbooleanrequerido

Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.

Ejemplo: false

notification_tokenstringrequerido

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.

Ejemplo: "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f"

receiver_idinteger(int64)requerido

Identificador único de una cuenta de cobro.

Ejemplo: 985101

conciliation_datestring(date-time)requerido

Fecha y hora de conciliación del pago. Formato ISO-8601.

Ejemplo: "2017-03-01T13:00:00.000Z"

subjectstringrequerido

Motivo del pago.

Ejemplo: "Test"

amountnumber(double)requerido

El monto del cobro.

Ejemplo: 1000

currencystringrequerido

El código de moneda en formato ISO-4217.

Ejemplo: "CLP"

statusstringrequerido

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.

Enum"pending""verifying""done"

Ejemplo: "done"

status_detailstringrequerido

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).

Enum"pending""normal""marked-paid-by-receiver""rejected-by-payer""marked-as-abuse""reversed"

Ejemplo: "normal"

bodystringrequerido

Detalle del cobro.

Ejemplo: "Test"

picture_urlstringrequerido

URL con imagen del cobro.

Ejemplo: "https://micomercio.com/picture_url"

receipt_urlstringrequerido

URL del comprobante de pago.

Ejemplo: "https://micomercio.com/order/receipt_url"

return_urlstringrequerido

URL donde se redirige al pagador luego que termina el pago.

Ejemplo: "https://micomercio.com/order/return_url"

cancel_urlstringrequerido

URL donde se redirige al pagador luego de que desiste hacer el pago.

Ejemplo: "https://micomercio.com/order/cancel_url"

notify_urlstringrequerido

URL del webservice donde se notificará el pago.

Ejemplo: "https://micomercio.com/webhook/notify_url"

notify_api_versionstringrequerido

Versión de la API de notificación.

Ejemplo: "3.0"

expires_datestring(date-time)requerido

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.

Ejemplo: "2023-12-31T15:45:00-04:00"

attachment_urlsArray of strings>= 0 itemsrequerido

Arreglo de URLs de archivos adjuntos al pago.

Ejemplo: ["https://micomercio.com/attachment1.pdf"]

bankstringrequerido

Nombre del banco seleccionado por el pagador.

Ejemplo: "Banco de Chile (Edwards Citi)"

bank_idstringrequerido

Identificador del banco seleccionado por el pagador.

Ejemplo: "dfFbF"

payer_namestringrequerido

Nombre del pagador.

Ejemplo: "Nombre Pagador"

payer_emailstring(email)requerido

Correo electrónico del pagador.

Ejemplo: "pagador@email.com"

personal_identifierstringrequerido

Identificador personal del pagador.

Ejemplo: "11.000.111-9"

bank_account_numberstringrequerido

Número de cuenta bancaria del pagador.

Ejemplo: "001120490689"

out_of_date_conciliationbooleanrequerido

Es true si la conciliación del pago fue hecha luego de la fecha de expiración.

Ejemplo: true

transaction_idstringrequerido

Identificador del pago asignado por el cobrador.

Ejemplo: "zwo3wqz6uulcvajt"

customstringrequerido

Campo genérico que asigna el cobrador al momento de hacer el pago.

Ejemplo: "<xml>...</xml>"

responsible_user_emailstringrequerido

Correo electrónico de la persona responsable del pago.

Ejemplo: "responsible@email.com"

send_remindersbooleanrequerido

Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios.

Ejemplo: true

send_emailbooleanrequerido

Es true cuando Khipu enviará el cobro por correo electrónico.

Ejemplo: true

payment_methodstringrequerido

Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada).

Enum"regular_transfer""simplified_transfer""not_available"

Ejemplo: "simplified_transfer"

funds_sourcestringrequerido

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.

Enum"debit""prepaid""credit""not-available"""

Ejemplo: "debit"

discountnumber(double)

Monto a descontar del valor pagado.

Ejemplo: 0

third_party_authorization_detailsstring

Ignorar este campo.

Response

application/json

{
  "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": "string"
}

Delete payment by Id

Request

Borrar un pago. Solo se pueden borrar pagos que estén pendientes de pagar. Esta operación no puede deshacerse.

Security

Api-Key

Path

idstring<= 255 charactersrequerido

Identificador del pago

curl -i -X DELETE \
  'https://payment-api.khipu.com/v3/payments/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa.

Bodyapplication/json

messagestringrequerido

Mensaje a desplegar al usuario.

Ejemplo: "Message."

Response

application/json

{
  "message": "Message."
}

Create payment

Request

Crea un pago en Khipu y obtiene las URLs para redirección al usuario para que complete el pago.

Security

Api-Key

Bodyapplication/json

amountnumber(double)requerido

El monto del cobro. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda.

Ejemplo: 1000

currencystring<= 255 charactersrequerido

El código de moneda en formato ISO-4217.

Enum"CLP""CLF""ARS""PEN""MXN""USD""EUR""BOB""COP"

Ejemplo: "CLP"

subjectstring<= 255 charactersrequerido

Motivo.

Ejemplo: "Cobro de prueba"

transaction_idstring<= 255 characters

Identificador propio de la transacción. Ej: número de factura u orden de compra.

Ejemplo: "zwo3wqz6uulcvajt"

customstring<= 1073741824 characters

Parámetro para enviar información personalizada de la transacción. Ej: documento XML con el detalle del carro de compra.

Ejemplo: "<xml>...</xml>"

bodystring<= 5120 characters

Descripción del cobro.

Ejemplo: "Cobro de orden de compra #123-abcdef"

bank_idstring<= 5 characters

Identificador del banco para usar en el pago.

Ejemplo: "SDdGj"

return_urlstring<= 1024 characters

La dirección URL a donde enviar al cliente mientras el pago está siendo verificado.

Ejemplo: "https://micomercio.com/order/return_url"

cancel_urlstring<= 1024 characters

La dirección URL a donde enviar al cliente si decide no hacer hacer la transacción.

Ejemplo: "https://micomercio.com/order/cancel_url"

picture_urlstring<= 1024 characters

Una dirección URL de una foto de tu producto o servicio.

Ejemplo: "https://micomercio.com/picture_url"

notify_urlstring<= 1024 characters

La dirección del web-service que utilizará khipu para notificar cuando el pago esté conciliado.

Ejemplo: "https://micomercio.com/webhook/notify_url"

contract_urlstring<= 1024 characters

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.

Ejemplo: "https://micomercio.com/contract_url"

notify_api_versionstring<= 255 characters

Versión de la API de notificaciones para recibir avisos por web-service.

Ejemplo: "3.0"

expires_datestring(date-time)

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.

Ejemplo: "2023-12-31T15:45:00-04:00"

send_emailboolean

Si es true, se enviará una solicitud de cobro al correo especificado en payer_email.

Ejemplo: false

payer_namestring<= 255 characters

Nombre del pagador. Es obligatorio cuando send_email es true.

Ejemplo: "Nombre Pagador"

payer_emailstring(email)<= 255 characters

Correo del pagador. Es obligatorio cuando send_email es true.

Ejemplo: "pagador@email.com"

send_remindersboolean

Si es true, se enviarán recordatorios de cobro.

Ejemplo: true

responsible_user_emailstring(email)<= 255 characters

Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro.

Ejemplo: "responsible@email.com"

fixed_payer_personal_identifierstring<= 255 characters

Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador.

Ejemplo: "11.000.111-9"

integrator_feestring<= 16 characters

Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada.

Ejemplo: "100"

collect_account_uuidstring<= 255 characters

Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia.

Ejemplo: "007367340234"

confirm_timeout_datestring(date-time)

Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601.

Ejemplo: "2017-03-01T13:00:00Z"

mandatory_payment_methodstring<= 255 characters

El cobro sólo se podrá pagar utilizando el medio de pago especificado. Los posibles valores para este campo se encuentran en el campo id de la respuesta del endpoint /api/3.0/merchants/paymentMethods.

Ejemplo: "simplified_transfer"

psp_client_merchant_namestring[ 3 .. 255 ] characters

Nombre del comercio final para quien un proveedor de servicios de pago procesa un pago. Requerido para transacciones de clientes PSP; no aplicable para otros. En caso de tratarse de un PSP de PSP, estos deben ingresarse separados por '->'.

Ejemplo: "PSP 1->PSP 2->Client Name"

curl -i -X POST \
  https://payment-api.khipu.com/v3/payments \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "amount": 1000,
    "currency": "CLP",
    "subject": "Cobro de prueba"
  }'

Responses

Operación exitosa. Devuelve un objeto JSON con la información del pago creado.

Bodyapplication/json

payment_idstringrequerido

Ejemplo: "gqzdy6chjne9"

payment_urlstringrequerido

URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.

Ejemplo: "https://khipu.com/payment/info/gqzdy6chjne9"

simplified_transfer_urlstringrequerido

URL de pago simplificado.

Ejemplo: "https://app.khipu.com/payment/simplified/gqzdy6chjne9"

transfer_urlstringrequerido

URL de pago normal.

Ejemplo: "https://khipu.com/payment/manual/gqzdy6chjne9"

app_urlstringrequerido

URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.

Ejemplo: "khipu:///pos/gqzdy6chjne9"

ready_for_terminalbooleanrequerido

Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.

Ejemplo: false

Response

application/json

{
  "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
}

Refund payment by Id

Request

Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes.

Security

Api-Key

Path

idstring<= 255 charactersrequerido

Identificador del pago

Bodyapplication/json

amountnumber(double)

El monto a devolver. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda. Si se omite el reembolso se hará por el total del monto del pago.

Ejemplo: 1000

curl -i -X POST \
  'https://payment-api.khipu.com/v3/payments/{id}/refunds' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Operación exitosa.

Bodyapplication/json

messagestringrequerido

Mensaje a desplegar al usuario.

Ejemplo: "Message."

Response

application/json

{
  "message": "Message."
}

Get payment prediction

Request

Predicción acerca del resultado de un pago, si podrá o no funcionar. Información adicional como máximo posible de transferir a un nuevo destinatario.

Security

Api-Key

Query

payer_emailstring<= 255 charactersrequerido

Correo electrónico del pagador

bank_idstring<= 255 charactersrequerido

Identificador del banco de origen

amountstring<= 255 charactersrequerido

Monto del pago

currencystring<= 255 charactersrequerido

Moneda en formato ISO-4217

curl -i -X GET \
  'https://payment-api.khipu.com/v3/predict?amount=string&bank_id=string&currency=string&payer_email=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa. Devuelve un objeto JSON con la predicción junto con información adiciónal.

Bodyapplication/json

new_destinatary_max_amountnumber(double)requerido

Monto máximo para transferir a un nuevo destinatario.

Ejemplo: 100000

max_amountnumber(double)requerido

El monto máximo posible para transferir.

Ejemplo: 5000000

resultstringrequerido

El resultado de la predicción.

Enum"ok""new_destinatary_amount_exceeded""max_amount_exceeded""new_destinatary_cool_down""not_available_account"

Ejemplo: "ok"

cool_down_datestringrequerido

Fecha de término para la restricción de monto en formato ISO-8601

Ejemplo: "2024-06-21T11:23:09.123Z"

Response

application/json

{
  "result": "ok",
  "max_amount": 5000000,
  "cool_down_date": "2024-06-21T11:23:09.123Z",
  "new_destinatary_max_amount": 100000
}

Post receiver

Request

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.

Security

Api-Key

Bodyapplication/json

admin_first_namestring<= 255 charactersrequerido

Nombre de pila del administrador de la cuenta de cobro a crear.

Ejemplo: "Nombre"

admin_last_namestring<= 255 charactersrequerido

Apellido del administrador de la cuenta de cobro a crear.

Ejemplo: "Apellido"

admin_emailstring(email)<= 255 charactersrequerido

Correo electrónico del administrador de la cuenta de cobro a crear.

Ejemplo: "admin@email.com"

country_codestring<= 2 charactersrequerido

Código alfanumérico de dos caracteres ISO 3166-1 del país de la cuenta de cobro a crear.

Ejemplo: "CL"

business_identifierstring[ 8 .. 255 ] charactersrequerido

Identificador tributario del cobrador asociado a la cuenta de cobro a crear.

Ejemplo: "99.999.999-9"

business_categorystring<= 255 charactersrequerido

Categoría tributaria o rubro tributario del cobrador asociado a la cuenta de cobro a crear.

Ejemplo: "VENTA AL POR MAYOR DE FRUTAS Y VERDURAS"

business_namestring<= 255 charactersrequerido

Nombre tributario del cobrador asociado a la cuenta de cobro a crear.

Ejemplo: "Nombre Tributario"

business_phonestring[ 5 .. 20 ] charactersrequerido

Teléfono del cobrador asociado a la cuenta de cobro a crear.

Ejemplo: "+56988887777"

business_address_line_1string[ 4 .. 300 ] charactersrequerido

Dirección del cobrador de la cuenta de cobro a crear.

Ejemplo: "Calle principal 1111"

business_address_line_2string[ 4 .. 300 ] charactersrequerido

Segunda línea de la dirección del cobrador de la cuenta de cobro a crear.

Ejemplo: "Oficina 3-A"

business_address_line_3string[ 4 .. 300 ] charactersrequerido

Tercera línea de la dirección del cobrador de la cuenta de cobro a crear.

Ejemplo: "Santiago"

contact_full_namestring<= 255 charactersrequerido

Nombre del contacto del cobrador.

Ejemplo: "Nombre Contacto"

contact_job_titlestring<= 255 charactersrequerido

Cargo del contacto del cobrador.

Ejemplo: "Tesorero"

contact_emailstring(email)<= 255 charactersrequerido

Correo electrónico del contacto del cobrador.

Ejemplo: "contacto@email.com"

contact_phonestring[ 5 .. 20 ] charactersrequerido

Teléfono del contacto del cobrador.

Ejemplo: "+56955553333"

bank_account_bank_idstring<= 5 characters

Identificador del banco.

Ejemplo: "SDdGj"

bank_account_typestring<= 255 characters

Tipo de cuenta. Es obligatorio si se utiliza el modelo alternativo de integrador de confianza.

Ejemplo: "Cuenta Corriente"

bank_account_identifierstring<= 50 characters

Identificador personal del dueño de la cuenta de banco.

Ejemplo: "11.333.555-7"

bank_account_namestring<= 255 characters

Nombre de la cuenta de banco.

Ejemplo: "Alias Cuenta"

bank_account_numberstring<= 255 characters

Número de la cuenta en el banco.

Ejemplo: "00347909823"

notify_urlstring<= 1024 characters

URL por omisión para el webservice donde se notificará el pago.

Ejemplo: "http://micomercio.com/account/notify_url"

rendition_urlstring<= 1024 characters

URL para el webservice donde se notificará la rendición.

Ejemplo: "http://micomercio.com/account/rendition_url"

curl -i -X POST \
  https://payment-api.khipu.com/v3/receivers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "admin_first_name": "Nombre",
    "admin_last_name": "Apellido",
    "admin_email": "admin@email.com",
    "country_code": "CL",
    "business_identifier": "99.999.999-9",
    "business_category": "VENTA AL POR MAYOR DE FRUTAS Y VERDURAS",
    "business_name": "Nombre Tributario",
    "business_phone": "+56988887777",
    "business_address_line_1": "Calle principal 1111",
    "business_address_line_2": "Oficina 3-A",
    "business_address_line_3": "Santiago",
    "contact_full_name": "Nombre Contacto",
    "contact_job_title": "Tesorero",
    "contact_email": "contacto@email.com",
    "contact_phone": "+56955553333"
  }'

Responses

Operación exitosa. Devuelve un objeto JSON con el identificador y secreto de la nueva cuenta de cobro.

Bodyapplication/json

receiver_idstringrequerido

Identificador único de la cuenta de cobro.

Ejemplo: "934568"

secretstringrequerido

Llave secreta de la cuenta de cobro, se usa para firmar todas las peticiones.

Ejemplo: "b2025dc47a29a04592fa3c1191110370db0e208c"

Response

application/json

{
  "receiver_id": "934568",
  "secret": "b2025dc47a29a04592fa3c1191110370db0e208c"
}

Get payment methods

Request

Obtiene el listado de medios de pago disponible para una cuenta de cobrador.

Security

Api-Key

Path

idnumberrequerido

Identificador de la cuenta de cobro

curl -i -X GET \
  'https://payment-api.khipu.com/v3/merchants/{id}/paymentMethods' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Operación exitosa. Devuelve un objeto JSON con la variedad de métodos de pago disponibles.

Bodyapplication/json

paymentMethodsArray of objectsnon-emptyrequerido

Arreglo con métodos de pago disponibles.

idstringrequerido

Identificador del medio de pago.

Ejemplo: "simplified_transfer"

namestringrequerido

Nombre del medio de pago.

Ejemplo: "simplified_transfer"

logo_urlstringrequerido

URL del logo sugerido para mostrar.

Ejemplo: "https://s3.amazonaws.com/static.khipu.com/buttons/2015/150x50-transparent.png"

Response

application/json

{
  "paymentMethods": [
    {
      "id": "simplified_transfer",
      "name": "simplified_transfer",
      "logo_url": "https://s3.amazonaws.com/static.khipu.com/buttons/2015/150x50-transparent.png"
    }
  ]
}

API Pagos Instantáneos (v3.0)

Get banks

Request

Responses

¿Fue útil esta info?

Confirm payment by Id

Request

Responses

¿Fue útil esta info?

Get payment by Id

Request

Responses

¿Fue útil esta info?

Delete payment by Id

Request

Responses

¿Fue útil esta info?

Create payment

Request

Responses

¿Fue útil esta info?

Refund payment by Id

Request

Responses

¿Fue útil esta info?

Get payment prediction

Request

Responses

¿Fue útil esta info?

Post receiver

Request

Responses

¿Fue útil esta info?

Get payment methods

Request

Responses

¿Fue útil esta info?