Licencia
https://api.khipu.com/
Este método se conecta a la cuenta especificada por el usuario en Administradora de Fondo de Cesantía (AFC) y retorna su "Saldo en cuenta".
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.
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.
https://api.khipu.com/v1/cl/services/afc.cl/balance
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/balance \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {}
}'Operación exitosa. Retorna un objeto JSON con los datos solicitados.
Identificador único de la operación.
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.
Contenedor para el saldo de las contribuciones.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "ContributionsBalance": { "CreationDate": "2017-07-22", "TotalBalance": "10000", "TotalBalanceCuota": "223.45", "Details": [ { … } ] } }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
Este método se conecta a la cuenta especificada por el usuario en Administradora de Fondo de Cesantía (AFC) y retorna el "Certificado de Movimientos" correspondiente al período consultado.
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.
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.
Año para el periodo a obtener. Rango desde 1970 hasta el año actual.
https://api.khipu.com/v1/cl/services/afc.cl/contributions-certificate
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/contributions-certificate \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {
"Period": "2021"
}
}'Operación exitosa. Retorna un objeto JSON con los datos solicitados.
Identificador único de la operación.
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.
Contenedor para movimientos de contribuciones.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "ContributionsCertificate": { "IdentifierNumber": "49PW-50JX-WLO9-6JVP", "CreationDate": "2023-09-28", "Title": "Certificado de movimiento de Cuenta Individual por Cesantía", "Description": "AFC CHILE S.A. certifica que la Cuenta Individual de Cesantía perteneciente al afiliado(a) AAAAA BBBBB CCCCC DDDDD, RUT 11.222.333-N registra los siguientes movimientos en el período de FEBRERO/2022 a AGOSTO/2023:", "Movements": [ { … } ], "Document": "<document>" } }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
Este método se conecta a la cuenta empleador especificada por el usuario en Administradora de Fondo de Cesantía (AFC) y retorna el "Saldo Aporte Empleador" para un Rol Único Nacional (RUN) de empleado.
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.
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.
Identificador único e inmutable utilizado para identificar al empleado (RUT).
Fecha de inicio de los aportes en formato ISO 8601 (YYYY-MM-DD).
https://api.khipu.com/v1/cl/services/afc.cl/employer/contributed-balance
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/employer/contributed-balance \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {
"EmployeeId": "10.111.111-1",
"ContributionStartDate": "2024-01-01"
}
}'Operación exitosa. Retorna un objeto JSON con los datos solicitados.
Identificador único de la operación.
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.
Contenedor de saldo aporte empleador.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "EmployerContributionsBalance": { "EmployeeId": "19.111.111-1", "NominalAmount": "65000", "Profitability": "20550", "AdministrationCosts": "7990", "EmployerContributionAmount": "99500", "Currency": "CLP" } }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
Este método se conecta a la cuenta especificada por el usuario en Administradora de Fondo de Cesantía (AFC) y retorna las "Ultimas Contribuciones Acreditadas" correspondientes al período consultado.
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.
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.
Periodo para el cual se recuperarán las ultimas cotizaciones acreditadas. De no ser proporcionado, se recuperará la última disponible.
https://api.khipu.com/v1/cl/services/afc.cl/last-credited-contribution
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/last-credited-contribution \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {}
}'Operación exitosa. Retorna un objeto JSON con los datos solicitados.
Identificador único de la operación.
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.
Contenedor de cotizaciones pagadas.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "PaidContributions": [ { "ContributionDate": "2017-07", "EmployerId": "11.222.333-4", "EmployerName": "KHIPU SPA", "TaxableIncome": "10000", "TaxedAmount": "1000", "PaymentDate": "2017-07-22" } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
Este método se conecta a la cuenta especificada por el usuario en Administradora de Fondo de Cesantía (AFC) y retorna las "Cotizaciones pagadas" correspondientes al período consultado.
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.
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.
Año para el periodo a obtener. Rango desde 1970 hasta el año actual.
https://api.khipu.com/v1/cl/services/afc.cl/paid-contributions-v2
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/paid-contributions-v2 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {
"Period": "2021"
}
}'Operación exitosa. Retorna un objeto JSON con los datos solicitados.
Identificador único de la operación.
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.
Contenedor de cotizaciones pagadas.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "PaidContributions": [ { "ContributionDate": "2017-07", "EmployerId": "11.222.333-4", "EmployerName": "KHIPU SPA", "TransactionCode": "101-01", "InvoiceNumber": "", "TaxableIncome": "10000", "TaxedAmount": "1000", "ChargedAmount": "1000", "PaymentDate": "2017-07-22", "PaymentType": "COMIS. PORC. SALDOS AFIL" } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
Este método se está descontinuando y se retirará en los próximos meses. Migre su implementación actual para usar tokens OAuth en su lugar.
Este método se conecta a la cuenta del usuario en AFC y retorna un token vinculado a esa cuenta que puede ser usado en operaciones futuras, evitando la necesidad de enviar sus credenciales en texto plano al llamar a los servicios bancarios.
Identificación del usuario con acceso a la cuenta en el sitio web (RUN, DNI).
Contraseña de la cuenta para el sitio web.
https://api.khipu.com/v1/cl/services/afc.cl/token
curl -i -X POST \
https://api.khipu.com/v1/cl/services/afc.cl/token \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Username": "11.111.111-1",
"Password": "wxyz1234!@#$"
}'Operación exitosa. Retorna un objeto JSON con el token de la cuenta en el campo Data.
Identificador único de la operación.
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.
Si la autenticación se ha realizado correctamente, incluye el 'Account Link' para la cuenta.
Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.
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
Indica cómo tratar este código de error específico, en función del tipo de error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "AccountLink": "dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB==" }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }