Skip to content
Download OpenAPI description
Overview
Languages
Servers
Production

https://api.khipu.com/

Request

This method connects to the user's specified account in Banco Credicoop-Empresas 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.

Security
JWT or Api-Key
Bodyapplication/jsonrequired
RequestDataobjectrequired
AccountNumberstring<= 20 charactersrequired
AccountCredentialobjectDeprecated
One of:
Deprecated

Use this value to call the service using the pre-generated account link.

CallbackUrlstring<= 255 characters

URL to send the response message using a POST verb.

Example: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/ar/banking/business/bancocredicoop.coop/transactions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "AccountNumber": "000011887755"
    }
  }'

Responses

Successful operation. Returns a JSON object with the transactions for the specified account in the Data field.

Bodyapplication/json
OperationIdstring<= 36 charactersrequired

Unique identifier of the operation.

Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequired

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.

Enum"OK""ERROR"
Example: "OK"
Dataobjectrequired
TransactionArray of objects>= 0 items
AdditionalInformationstringrequired

This field can be used to display relevant information specific to the response, for instance indicating that the Data field is incomplete.

Example: null
Errorobjectrequired
Codestring

Internal system code that identifies the error.

Example: "E201"
Typestring

Indicates how to treat this specific error code, based on the type of error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Example: "RETRY_IMMEDIATELY"
Descriptionstring

Description associated with the error code.

Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstringrequired

null in sync requests.

Example: 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 }