Banco de Chile (v1.0)

Download OpenAPI description
Overview
Languages
Servers
Production

https://api.khipu.com/

Current Balances

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna los saldos actuales de la cuenta (también conocido como "Balance en cartola saldos y movimientos").

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountNumberstring[ 1 .. 20 ] charactersrequerido

Número de cuenta bancaria.

Ejemplo: "11887755"
Currencystring<= 3 characters^[A-Z]{3,3}$

Identificación de la moneda en la que se mantiene la cuenta. Utilización: La moneda sólo debe utilizarse en caso de que sea necesaria para identificar la cuenta.

Ejemplo: "CLP"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/current/balances \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "AccountNumber": "11887755"
    }
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de saldos.

BalanceArray of objects>= 0 itemsrequerido

Conjunto de elementos utilizados para definir los detalles de balance. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Balance": [ { "AccountId": "873458", "CreditDebitIndicator": "Credit", "DateTime": "2017-07-21T17:32:28-0400", "Type": "ClosingAvailable", "Amount": {} } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Latest Transactions

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna las transacciones más recientes con el límite determinado por el banco (también conocido como "Últimos movimientos").

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountNumberstring[ 1 .. 20 ] charactersrequerido

Número de cuenta bancaria.

Ejemplo: "11887755"
Currencystring<= 3 characters^[A-Z]{3,3}$

Identificación de la moneda en la que se mantiene la cuenta. Utilización: La moneda sólo debe utilizarse en caso de que sea necesaria para identificar la cuenta.

Ejemplo: "CLP"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/latest/transactions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "AccountNumber": "11887755"
    }
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de transacciones.

TransactionArray of objects>= 0 itemsrequerido

Proporciona más detalles sobre las transacciones. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Transaction": [ { "AccountId": "873458", "AddressLine": "SUCURSAL SANTIAGO CENTRO", "BookingDateTime": "2017-07-22T00:00:00-0400", "CreditDebitIndicator": "Credit", "Status": "Booked", "TransactionId": "c830d0c9a0904ea6badbaf8e25ff6e87", "TransactionInformation": "PAGO DE CUENTAS", "ValueDateTime": "2017-07-21T17:32:28-0400", "Amount": {}, "Balance": {}, "BankTransactionCode": {}, "SupplementaryData": {} } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Accounts

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna todas las cuentas que se pueden encontrar dentro del sitio web.

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/products/accounts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {}
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de cuentas.

AccountArray of objectsrequerido

Proporciona más detalles sobre las cuentas. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Account": [ { "Identifier": "413246", "Description": "Cuenta corriente", "Type": "CheckingAccount", "Balance": [], "Limit": [] } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Insurances

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna todos los seguros contratados asociados a la cuenta que pueden encontrarse dentro del sitio web.

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/products/insurance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {}
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de seguros.

InsuranceArray of objectsrequerido

Proporciona más detalles sobre los seguros. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Insurance": [ { "PolicyNumber": "80001566", "InsuranceName": "Integral Support", "InsuranceNumber": "100001b151", "EffectiveDateStart": "2023-09-20", "EffectiveDateEnd": "2024-07-30", "Insurer": "Insurance Chubb", "PlanName": "Plan Tlmk Uf 100", "PolicyPeriod": "Yearly", "Status": "Active", "InstalmentAmount": {} } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Products

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna todos los productos contratados (Cuentas, Seguros, Inversiones y Créditos) que se pueden encontrar dentro del sitio web (si el servicio bancario no muestra los datos de algún producto debido a problemas con el sitio web, dicho producto será omitido de la respuesta).

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/products \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {}
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de productos.

Productobjectrequerido

Proporciona más detalles sobre los productos.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Product": { "Account": [ {} ], "Insurance": [ {} ], "Investment": [ {} ], "Loan": [ {} ] } }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Recipients

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna la lista de destinatarios.

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/recipients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {}
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de destinatarios.

RecipientsArray of objects>= 0 itemsrequerido

Proporciona más detalles sobre los destinatarios. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Recipients": [ { "RecipientId": "11.111.111-1", "BankCode": "012", "BankName": "Banco Estado", "ProductCode": "CCT", "ProductName": "Cuenta Corriente", "AccountNumber": "873458", "Email": "example@mail.com", "Alias": "Joe 2", "Name": "Joe Bloggs", "Fav": true } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Statements Transactions

Request

Este método se conecta a la cuenta especificada por el usuario en Banco de Chile - Personas y retorna las transacciones registradas en los estados de cuenta emitidos por el banco dentro del rango de fechas especificado (también conocido como "Cartola histórica").

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

AccountNumberstring[ 1 .. 20 ] charactersrequerido

Número de cuenta bancaria.

Ejemplo: "11887755"
BookingDateStartstring^(19[7-9][0-9]|20([0-1][0-9]|2[0-4]))-(0[1-9]...requerido

Fecha de inicio en formato ISO 8601 (YYYY-MM) utilizada para obtener las transacciones.

Ejemplo: "2022-07"
BookingDateEndstring^(19[7-9][0-9]|20([0-1][0-9]|2[0-4]))-(0[1-9]...requerido

Fecha final en formato ISO 8601 (YYYY-MM) utilizada para obtener las transacciones.

Ejemplo: "2022-07"
Currencystring<= 3 characters^[A-Z]{3,3}$

Identificación de la moneda en la que se mantiene la cuenta. Utilización: La moneda sólo debe utilizarse en caso de que sea necesaria para identificar la cuenta.

Ejemplo: "CLP"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

One of:
Deprecado

Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/statements/transactions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "AccountNumber": "11887755",
      "BookingDateStart": "2022-07",
      "BookingDateEnd": "2022-07"
    }
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor de transacciones.

TransactionArray of objects>= 0 itemsrequerido

Proporciona más detalles sobre las transacciones. Puede ser un arreglo vacío.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando este enlace

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Transaction": [ { "AccountId": "873458", "AddressLine": "SUCURSAL SANTIAGO CENTRO", "BookingDateTime": "2017-07-22T00:00:00-0400", "CreditDebitIndicator": "Credit", "Status": "Booked", "TransactionId": "c830d0c9a0904ea6badbaf8e25ff6e87", "TransactionInformation": "PAGO DE CUENTAS", "Amount": {}, "Balance": {}, "BankTransactionCode": {} } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Booked Range Transactions / Card Purchases

Request

This method connects to the user's specified account in Banco Chile-Personas and returns the booked transactions for purchases made with the specified credit card registered in the statements issued by the bank within the specified date range (also known as "Movimientos facturados").

Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.

LastDigitsstring= 4 charactersrequerido

A four-digit number used to identify the card which corresponds to the last four digits of the card number.

Ejemplo: "9999"
BookingDateStartstring^((19[7-9][0-9])|(20[0-1][0-9])|(202[0-3]))-(...requerido

Start date used for fetch the transactions, in ISO 8601 format (yyyy-mm)

Ejemplo: "2022-07"
BookingDateEndstring^((19[7-9][0-9])|(20[0-1][0-9])|(202[0-3]))-(...requerido

Start date used for fetch the transactions, in ISO 8601 format (yyyy-mm)

Ejemplo: "2022-07"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

One of:
Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

CallbackUrlstring<= 255 characters

URL to send the response message using a POST verb.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/booked/range/transactions/card-purchases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "LastDigits": "9999",
      "BookingDateStart": "2022-07",
      "BookingDateEnd": "2022-07"
    }
  }'

Responses

Successful operation. Returns a JSON object with the booked transactions for the specified account in a given date range.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Unique identifier of the operation.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Container for Card Purchase. Can be an empty array.

CardInstrumentobjectrequerido

Provides further details of the card instrument.

StatementArray of objects>= 0 items

Provides further details on a statement resource.

TransactionArray of objects>= 0 items

Provides further details on an entry in the report.

AdditionalInformationstring or nullrequerido

This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.

Ejemplo: null
Errorobject or nullrequerido

Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link

Ejemplo: null
Codestring

Internal system code that identifies the error.

Ejemplo: "E201"
Typestring

Indicates how to treat this specific error code, based on the type of error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Description associated with the error code.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null in sync requests.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "CardInstrument": { "Identification": "9999", "Type": "Mastercard Black", "Status": "Active", "Cardholder": { "Identification": "11.111.111-1", "Name": "Joe Bloggs" } }, "Statement": [ { "MainCardId": "9999", "CreationDateTime": "2017-07-21T17:32:28-0400", "EndDateTime": "2017-06-30T23:59:59-0400", "StartDateTime": "2017-06-01T00:00:00-0400", "ExpirationDateTime": "2017-06-01T00:00:00-0400", "InvoicedAmountLCY": {}, "InvoicedAmountFCY": {}, "MinimumPayment": {}, "Type": "RegularPeriodic" } ], "Transaction": [ { "MainCardId": "9999", "OperationCardId": "9999", "AddressLine": "SUCURSAL SANTIAGO CENTRO", "BookingDateTime": "2017-07-22T00:00:00-0400", "CreditDebitIndicator": "Credit", "Instalment": {}, "LocalForeignIndicator": "Local", "Status": "Booked", "TransactionInformation": "PAGO DE CUENTAS", "ValueDateTime": "2017-07-21T17:32:28-0400", "Amount": {}, "SupplementaryData": [] } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }

Pending Current Transaction / Card Purchases

Request

This method connects to the user's specified account in Banco Chile-Personas and returns the last transactions for purchases made with the specified credit card which have not been invoiced yet (also known as "Movimientos no facturados").

Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.

LastDigitsstring= 4 charactersrequerido

A four-digit number used to identify the card which corresponds to the last four digits of the card number.

Ejemplo: "9999"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

One of:
Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

CallbackUrlstring<= 255 characters

URL to send the response message using a POST verb.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/bancochile.cl/pending/current/transactions/card-purchases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "LastDigits": "9999"
    }
  }'

Responses

Successful operation. Returns a JSON object with the transactions for the specified account in the Data field.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Unique identifier of the operation.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Container for Card Purchase. Can be an empty array.

CardInstrumentobjectrequerido

Provides further details of the card instrument.

StatementArray of objects>= 0 items

Provides further details on a statement resource.

TransactionArray of objects>= 0 items

Provides further details on an entry in the report.

AdditionalInformationstring or nullrequerido

This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.

Ejemplo: null
Errorobject or nullrequerido

Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link

Ejemplo: null
Codestring

Internal system code that identifies the error.

Ejemplo: "E201"
Typestring

Indicates how to treat this specific error code, based on the type of error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Description associated with the error code.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null in sync requests.

Ejemplo: null
Response
application/json
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "CardInstrument": { "Identification": "9999", "Type": "Mastercard Black", "Status": "Active", "Cardholder": { "Identification": "11.111.111-1", "Name": "Joe Bloggs" } }, "Statement": [ { "MainCardId": "9999", "CreationDateTime": "2017-07-21T17:32:28-0400", "EndDateTime": "2017-06-30T23:59:59-0400", "StartDateTime": "2017-06-01T00:00:00-0400", "ExpirationDateTime": "2017-06-01T00:00:00-0400", "InvoicedAmountLCY": {}, "InvoicedAmountFCY": {}, "MinimumPayment": {}, "Type": "RegularPeriodic" } ], "Transaction": [ { "MainCardId": "9999", "OperationCardId": "9999", "AddressLine": "SUCURSAL SANTIAGO CENTRO", "BookingDateTime": "2017-07-22T00:00:00-0400", "CreditDebitIndicator": "Credit", "Instalment": {}, "LocalForeignIndicator": "Local", "Status": "Booked", "TransactionInformation": "PAGO DE CUENTAS", "ValueDateTime": "2017-07-21T17:32:28-0400", "Amount": {}, "SupplementaryData": [] } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }