Skip to content
Open Finance
/
API Open Finance
/
Chile
/
Servicios
/
TGR

TGR (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

Current Agreements v2

Request

Este método se conecta a la cuenta especificada por el usuario en la Tesorería General de la Republica (TGR) y retorna los "Convenios vigentes".

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.

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/services/tgr.cl/current-agreements-v2 \
  -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 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 resoluciones de convenios vencidos.

ResolutionsArray of objectsrequired

Contenedor de resoluciones.

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": {
    "Resolutions": [
      {
        "ResolutionId": 1000,
        "ResolutionDate": "2017-07-22",
        "PaymentType": "CONVENIO CON CONDONACION",
        "NumberOfDebts": 1,
        "NumberOfInstalments": 10,
        "NetBalance": { … },
        "ResolutionDetails": { … },
        "Debts": [ … ],
        "Instalments": [ … ]
      }
    ]
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}

Expired Agreements v2

Request

Este método se conecta a la cuenta especificada por el usuario en la Tesorería General de la Republica (TGR) y retorna los "Convenios vencidos".

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.

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/services/tgr.cl/expired-agreements-v2 \
  -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 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 resoluciones de convenios vencidos.

ResolutionsArray of objectsrequired

Contenedor de resoluciones.

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": {
    "Resolutions": [
      {
        "ResolutionId": 1000,
        "ResolutionDate": "2017-07-22",
        "PaymentType": "CONVENIO CON CONDONACION",
        "NumberOfDebts": 1,
        "NumberOfInstalments": 10,
        "NetBalance": { … },
        "ResolutionDetails": { … },
        "ExpirationCode": 8,
        "Debts": [ … ],
        "Instalments": [ … ]
      }
    ]
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}