Skip to content
Open Finance
/
API Open Finance
/
Chile
/
Banca
/
Empresas
/
Banco BICE

Banco BICE (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

Current Balances

Request

Este método se conecta a la cuenta especificada por el usuario en Banco BICE - Empresas y retorna los saldos actuales de la cuenta (también conocido como "Saldo en línea").

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/jsonrequired
RequestDataobjectrequired

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 ] charactersrequired

Número de cuenta bancaria.

Example: "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.

Example: "CLP"
AccountCredentialobjectDeprecated

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

One of:
Deprecated

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.

Example: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/business/bice.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 charactersrequired

Identificador único de la operación.

Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequired

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"
Example: "OK"
Dataobject or nullrequired

Contenedor de saldos.

BalanceArray of objects>= 0 itemsrequired

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

AdditionalInformationstring or nullrequired

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

Example: null
Errorobject or nullrequired

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

Example: null
Codestring

Código interno del sistema que identifica el error.

Example: "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"
Example: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

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

null en peticiones sincrónicas.

Example: 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 BICE - Empresas 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/jsonrequired
RequestDataobjectrequired

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 ] charactersrequired

Número de cuenta bancaria.

Example: "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.

Example: "CLP"
AccountCredentialobjectDeprecated

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

One of:
Deprecated

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.

Example: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/business/bice.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 charactersrequired

Identificador único de la operación.

Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequired

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"
Example: "OK"
Dataobject or nullrequired

Contenedor de transacciones.

TransactionArray of objects>= 0 itemsrequired

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

AdditionalInformationstring or nullrequired

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

Example: null
Errorobject or nullrequired

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

Example: null
Codestring

Código interno del sistema que identifica el error.

Example: "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"
Example: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

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

null en peticiones sincrónicas.

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

Statements Transactions

Request

Este método se conecta a la cuenta especificada por el usuario en Banco BICE - Empresas y retorna las transacciones registradas en los estados de cuenta emitidos por el banco dentro del rango de fechas especificado (también conocido como "Consulta de 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/jsonrequired
RequestDataobjectrequired

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 ] charactersrequired

Número de cuenta bancaria.

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

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

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

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

Example: "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.

Example: "CLP"
AccountCredentialobjectDeprecated

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

One of:
Deprecated

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.

Example: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/business/bice.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 charactersrequired

Identificador único de la operación.

Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequired

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"
Example: "OK"
Dataobject or nullrequired

Contenedor de transacciones.

TransactionArray of objects>= 0 itemsrequired

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

AdditionalInformationstring or nullrequired

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

Example: null
Errorobject or nullrequired

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

Example: null
Codestring

Código interno del sistema que identifica el error.

Example: "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"
Example: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

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

null en peticiones sincrónicas.

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