Banco BICE (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 BICE - Personas 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/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/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 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 BICE - 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/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 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", "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 }

Recipients

Request

Este método se conecta a la cuenta especificada por el usuario en Banco BICE - 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/bice.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", "Name": "Joe Bloggs" } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }