Licencia
https://api.khipu.com/
This method connects to the user's specified account in DemoBank and returns all available accounts (accounts, credit cards, etc.). Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.
Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/accounts
curl -i -X POST \
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/accounts \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {}
}'Successful operation. Returns a JSON object with the balance for the specified account in the Data field.
Unique identifier of the operation.
Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.
Container for Accounts. Can be an empty array.
This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.
Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link
Indicates how to treat this specific error code, based on the type of error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Account": [ { "AccountId": "005553344110", "Status": "Enabled", "StatusUpdateDateTime": "2017-07-21T17:32:28-0400", "Currency": "CLP", "AccountType": "Personal", "AccountSubType": "CurrentAccount", "Description": "CUENTA DE AHORRO", "Nickname": "AHORROS", "OpeningDate": "2002-11-30" } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
This method connects to the user's specified account in DemoBank and returns the account's current balance. Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.
Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/balance
curl -i -X POST \
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/balance \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {
"AccountNumber": "000011887755"
}
}'Successful operation. Returns a JSON object with the balance for the specified account in the Data field.
Unique identifier of the operation.
Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.
Container for Balances. Can be an empty array.
This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.
Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link
Indicates how to treat this specific error code, based on the type of error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Balance": [ { "AccountId": "873458", "CreditDebitIndicator": "Credit", "DateTime": "2017-07-21T17:32:28-0400", "Type": "ClosingAvailable", "Amount": [ … ], "CreditLine": { … } } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
This method connects to the user's specified account in DemoBank and returns the desired statement. Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.
Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/statements
curl -i -X POST \
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/statements \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"RequestData": {
"AccountNumber": "000011887755"
}
}'Successful operation. Returns a JSON object with the desired statement for the specified account in the Data field.
Unique identifier of the operation.
Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.
Container for Statements. Can be an empty array.
This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.
Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link
Indicates how to treat this specific error code, based on the type of error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "Statement": [ { "AccountId": "873458", "CreationDateTime": "2017-07-21T17:32:28-0400", "EndDateTime": "2017-06-30T23:59:59-0400", "StartDateTime": "2017-06-01T00:00:00-0400", "StatementDescription": [ … ], "StatementId": "4525f6656f4248a99d289fe8d213557d", "StatementReference": "a2c557c63450", "Type": "RegularPeriodic", "StatementAmount": [ … ], "StatementBenefit": [ … ], "StatementDateTime": [ … ], "StatementFee": [ … ], "StatementInterest": [ … ], "StatementRate": [ … ], "StatementValue": [ … ] } ] }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }
This method connects to the user's specified account in DemoBank and returns the transactions for the current day. Using the CallbackUrl field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill your request within a reasonable time frame. If you want the response immediately, skip the field CallbackUrl but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.
Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/transactions
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"
}
}'Successful operation. Returns a JSON object with the transactions for the specified account in the Data field.
Unique identifier of the operation.
Operation status. OK means that the service was executed successfully even if it does not return Data. ERROR indicates that something happened that prevented the successful completion of the process.
Container for Transactions. Can be an empty array.
This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.
Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link
Indicates how to treat this specific error code, based on the type of error.
{ "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 }
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.
This method connects to the user's account in DemoBank and returns a token linked to that account that can be used in further operations, avoiding the need to send your credentials in plain text when calling the banking services.
User identification with access to the bank's account (RUN, DNI).
https://api.khipu.com/v1/cl/banking/personal/demo-bank.khipu.com/token
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!@#$"
}'Successful operation. Returns a JSON object with the token for the account in the Data field.
Unique identifier of the operation.
Operation status, "OK" meaning that the credentials were correct and the account link was generated.
If the authentication challenge was successful, it includes the link for the account.
This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.
Object with the error details, used when Status=ERROR. If Status=OK this field will be null. You can read a complete explanation of this object visiting this link
Indicates how to treat this specific error code, based on the type of error.
{ "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4", "Status": "OK", "Data": { "AccountLink": "dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB==" }, "AdditionalInformation": null, "Error": null, "LifeSpan": null }