Open Finance
/
API Open Finance
/
Argentina
/
Banca
/
Personas
/
Banco Ciudad
/
Transactions

Banco Ciudad (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Licencia

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

Transactions

Request

Este método se conecta a la cuenta especificada por el usuario en Banco Ciudad-Personasy retorna las transacciones del día actual.

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

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

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.

AccountNumberstring<= 20 charactersrequerido

Bank account number.

Ejemplo: "000011887755"
AccountCredentialAccountLinkCredential (object) or AccountAuthCredential (object)Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

One of:
Deprecado

Attention: The use of this field is mandatory when using Api Key authentication.

CallbackUrlstring<= 255 characters

URL to send the response message using a POST verb.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/ar/banking/personal/bancociudad.com.ar/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 charactersrequerido

Unique identifier of the operation.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

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"
Ejemplo: "OK"
Dataobject or nullrequerido

Container for Transactions. Can be an empty array.

TransactionArray of objects>= 0 items

Provides further details on an entry in the report.

AdditionalInformationstring or nullrequerido

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

Ejemplo: null
Errorobject or nullrequerido

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

Ejemplo: null
Codestring

Internal system code that identifies the error.

Ejemplo: "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"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Description associated with the error code.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null in sync requests.

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