Saltar al contenido

Referencia de API

Instituciones

Lista de bancos con su estado en el modo de la llave. Es la misma lista que muestra el widget. Detalle de cada banco en Instituciones.

Listar instituciones

GET/v1/institutions

Acepta llave secret o publishable. URL completa: https://api.banky.cl/v1/institutions

Devuelve todas las instituciones en una sola página (has_more siempre es false). status es available si se puede conectar en el modo de la llave y coming_soon si no. Con una llave test, solo el Banco de Prueba (test_only: true) está disponible; con una llave live, el Banco de Prueba no aparece.

El ejemplo muestra parte de la respuesta con una llave test.

Ejemplo de petición

curl "https://api.banky.cl/v1/institutions" \
  -H "Authorization: Bearer $BANKY_SECRET_KEY"

Respuesta

application/json

200
{
  "object": "list",
  "data": [
    {
      "id": "bci",
      "object": "institution",
      "name": "BCI",
      "status": "coming_soon",
      "holder_types": [
        "business"
      ],
      "test_only": false
    },
    {
      "id": "santander",
      "object": "institution",
      "name": "Santander",
      "status": "coming_soon",
      "holder_types": [
        "individual",
        "business"
      ],
      "test_only": false
    },
    {
      "id": "banco_de_chile",
      "object": "institution",
      "name": "Banco de Chile",
      "status": "coming_soon",
      "holder_types": [
        "individual",
        "business"
      ],
      "test_only": false
    },
    {
      "id": "sandbox",
      "object": "institution",
      "name": "Banco de Prueba",
      "status": "available",
      "holder_types": [
        "individual",
        "business"
      ],
      "test_only": true
    }
  ],
  "has_more": false
}