Skip to content
Open Finance
/
API Open Finance
/
Chile
/
Banca
/
Personas
/
DemoBank

DemoBank (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Licencia

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

Transactions

Request

Éste método conecta con la cuenta del usuario especificada en DemoBank y devuelve las transacciones del día actual. 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 banco del usuario y extraer datos. Los campos obligatorios indican los valores que son necesarios para identificar la cuenta deseada.

AccountNumberstring<= 20 charactersrequerido

Número de cuenta bancaria.

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

Atención
El uso de este campo es obligatorio al usar autenticación con Api Key.
Autenticación de la cuenta del usuario para realizar operaciones.

One of:
Deprecado

Atención
El uso de este campo es obligatorio al usar autenticación con Api Key.
Autenticación de la cuenta del usuario para realizar operaciones.

CallbackUrlstring<= 255 characters

URL al que se enviará la respuesta del servicio usando el 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/demo-bank.khipu.com/transactions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "AccountNumber": "000011887755"
    }
  }'

Responses

Operación exitosa. Retorna un objeto JSON con las transacciones de la cuenta especificada en el campo Data.

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 ejecutó correctamente, incluso si no devuelve datos. ERROR indica que ocurrió algo que impidió la finalización exitosa del proceso.

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

Contener para las transacciones. Puede ser un array vacío.

TransactionArray of objects>= 0 items

Proveé más detalles sobre una entrada en el reporte.

AdditionalInformationstring or nullrequerido

Éste campo puede ser usado 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á null. Puedes 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, según el 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, que explica el problema ocurrido y cómo solucionarlo.

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

null en operaciones síncronas.

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",
        "StatementReference": [ … ],
        "Status": "Booked",
        "TransactionId": "c830d0c9a0904ea6badbaf8e25ff6e87",
        "TransactionInformation": "PAGO DE CUENTAS",
        "TransactionMutability": "Immutable",
        "TransactionReference": "09cce92d-494b-4f29-8584-6a0409a052c7",
        "ValueDateTime": "2017-07-21T17:32:28-0400",
        "Amount": { … },
        "Balance": { … },
        "BankTransactionCode": { … },
        "CardInstrument": { … },
        "ChargeAmount": { … },
        "CreditorAccount": { … },
        "CreditorAgent": { … },
        "CurrencyExchange": { … },
        "DebtorAccount": { … },
        "DebtorAgent": { … },
        "MerchantDetails": { … },
        "ProprietaryBankTransactionCode": { … },
        "SupplementaryData": [ … ]
      }
    ]
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}

Account LinkDeprecado

Request

Deprecado
Este método está deprecado y se retirará en los próximos meses. Por favor, migre su implementación actual para usar tokens OAuth en su lugar.

Éste método conecta con la cuenta del usuario en DemoBank y devuelve un token vinculado a esa cuenta que puede ser usado en operaciones posteriores, evitando la necesidad de enviar sus credenciales en texto plano al llamar a los servicios bancarios.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
Usernamestring[ 1 .. 12 ] charactersrequerido

Identificación del usuario con acceso a la cuenta del banco (RUN, DNI).

Ejemplo: "11.111.111-1"
Passwordstring[ 1 .. 24 ] charactersrequerido

Clave de acceso del usuario a la cuenta del banco.

Ejemplo: "wxyz1234!@#$"
curl -i -X POST \
  https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Username": "11.111.111-1",
    "Password": "wxyz1234!@#$"
  }'

Responses

Operación exitosa. Devuelve un objeto JSON con el token para la cuenta en el campo Data.

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 las credenciales son correctas y se generó el enlace de la cuenta. (AccountLink)

Value"OK"
Ejemplo: "OK"
Dataobject or nullrequerido

Si la autenticación fue exitosa, incluye el enlace para la cuenta.(AccountLink)

AccountLinkstringrequerido

Token generado para acceder a la cuenta bancaria.

Ejemplo: "dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB=="
AdditionalInformationstring or nullrequerido

Éste campo puede ser usado 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á null. Puedes 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, según el 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, que explica el problema ocurrido y cómo solucionarlo.

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

Esté campo debe ser null en peticiones síncronas, ya que el token generado no tiene una duración definida. En peticiones asíncronas, indica el tiempo estimado en que el token generado será válido, en formato ISO 8601.

Ejemplo: null
Response
application/json
{
  "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4",
  "Status": "OK",
  "Data": {
    "AccountLink": "dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB=="
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}