# Transactions

This method connects to the user's specified account in  and returns the transactions for the current day. 

Using the  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  but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.

Endpoint: POST /v1/ar/banking/business/bancocredicoop.coop/transactions
Version: v1.0
Security: JWT, Api-Key

## Request fields (application/json):

  - `RequestData` (object, required)
    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.

  - `RequestData.AccountNumber` (string, required)
    Bank account number.

  - `RequestData.AccountCredential` (any)
    Attention: The use of this field is mandatory when using Api Key authentication.

  - `CallbackUrl` (string)
    URL to send the response message using a POST verb.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status.  means that the service was executed successfully even if it does not return Data.  indicates that something happened that prevented the successful completion of the process.
    Enum: "OK", "ERROR"

  - `Data` (object, required)
    Container for Transactions. Can be an empty array.

  - `Data.Transaction` (array)
    Provides further details on an entry in the report.

  - `Data.Transaction.AccountId` (string, required)
    A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
    Example: "873458"

  - `Data.Transaction.BookingDateTime` (string, required)
    Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.
    Example: "2017-07-22T00:00:00-0400"

  - `Data.Transaction.CreditDebitIndicator` (string, required)
    Indicates whether the transaction is a credit or a debit entry.
    Enum: "Credit", "Debit"

  - `Data.Transaction.Status` (string, required)
    Status of a transaction entry on the books of the account servicer.
    Enum: "Booked", "Pending", "Rejected"

  - `Data.Transaction.Amount` (object, required)
    Amount of money in the cash transaction entry.

  - `Data.Transaction.Amount.Amount` (number, required)
    A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    Example: 10000

  - `Data.Transaction.Amount.Currency` (string, required)
    A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
    Example: "CLP"

  - `Data.Transaction.AddressLine` (string)
    Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
    Example: "SUCURSAL SANTIAGO CENTRO"

  - `Data.Transaction.StatementReference` (array)
    Unique reference for the statement. This reference may be optionally populated if available.
    Example: ["a2c557c63450"]

  - `Data.Transaction.TransactionId` (string)
    Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
    Example: "c830d0c9a0904ea6badbaf8e25ff6e87"

  - `Data.Transaction.TransactionInformation` (string)
    Further details of the transaction. This is the transaction narrative, which is unstructured text.
    Example: "PAGO DE CUENTAS"

  - `Data.Transaction.TransactionMutability` (string)
    Specifies the Mutability of the Transaction record.
    Enum: "Mutable", "Immutable"

  - `Data.Transaction.TransactionReference` (string)
    Unique reference for the transaction.
    Example: "09cce92d-494b-4f29-8584-6a0409a052c7"

  - `Data.Transaction.ValueDateTime` (string)
    Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.
    Example: "2017-07-21T17:32:28-0400"

  - `Data.Transaction.Balance` (object)
    Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.

  - `Data.Transaction.Balance.Type` (string, required)
    Balance type, in a coded form.
    Enum: "ClosingAvailable", "ClosingBooked", "ClosingCleared", "Expected", "ForwardAvailable", "Information", "InterimAvailable", "InterimBooked", "InterimCleared", "OpeningAvailable", "OpeningBooked", "OpeningCleared", "PreviouslyClosedBooked"

  - `Data.Transaction.Balance.Amount` (object, required)
    Amount of money of the cash balance after a transaction entry is applied to the account.

  - `Data.Transaction.BankTransactionCode` (object)
    Set of elements used to fully identify the type of underlying transaction resulting in an entry.

  - `Data.Transaction.BankTransactionCode.Code` (string, required)
    Specifies the family within a domain.
    Example: "RCDT"

  - `Data.Transaction.BankTransactionCode.SubCode` (string, required)
    Specifies the sub-product family within a specific family.
    Example: "DMCT"

  - `Data.Transaction.CardInstrument` (object)
    Set of elements to describe the card instrument used in the transaction.

  - `Data.Transaction.CardInstrument.CardSchemeName` (string, required)
    Name of the card scheme.
    Enum: "AmericanExpress", "Diners", "Discover", "MasterCard", "VISA"

  - `Data.Transaction.CardInstrument.AuthorisationType` (string)
    The card authorisation type.
    Enum: "ConsumerDevice", "Contactless", "None", "PIN"

  - `Data.Transaction.CardInstrument.Identification` (string)
    Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
    Example: "BLACK CARD ****6328"

  - `Data.Transaction.CardInstrument.Name` (string)
    Name of the cardholder using the card instrument.
    Example: "JOHN DOE"

  - `Data.Transaction.ChargeAmount` (object)
    Transaction charges to be paid by the charge bearer.

  - `Data.Transaction.CreditorAccount` (object)
    Unambiguous identification of the account of the creditor, in the case of a debit transaction.

  - `Data.Transaction.CreditorAccount.Identification` (string)
    Identification assigned by an institution to identify an account. This identification is known by the account owner.
    Example: "99056723"

  - `Data.Transaction.CreditorAccount.Name` (string)
    The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
    Example: "JOHN DOE"

  - `Data.Transaction.CreditorAccount.SchemeName` (string)
    Name of the identification scheme, in a coded form as published in an external list.
    Example: "BBAN"

  - `Data.Transaction.CreditorAccount.SecondaryIdentification` (string)
    This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
    Example: "1373-86353478"

  - `Data.Transaction.CreditorAgent` (object)
    Financial institution servicing an account for the creditor.

  - `Data.Transaction.CreditorAgent.Identification` (string)
    Unique and unambiguous identification of a financial institution or a branch of a financial institution.
    Example: "DEMO BANK"

  - `Data.Transaction.CreditorAgent.Name` (string)
    Name by which an agent is known and which is usually used to identify that agent.
    Example: "DEMO BANK CHILE"

  - `Data.Transaction.CreditorAgent.PostalAddress` (object)
    Information that locates and identifies a specific address, as defined by postal services.

  - `Data.Transaction.CreditorAgent.PostalAddress.AddressLine` (array)
    Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
    Example: ["AGUSTINAS 1234, SANTIAGO"]

  - `Data.Transaction.CreditorAgent.PostalAddress.AddressType` (string)
    Identifies the nature of the postal address.
    Enum: "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Residential", "Statement"

  - `Data.Transaction.CreditorAgent.PostalAddress.BuildingNumber` (string)
    Number that identifies the position of a building on a street.
    Example: "1234"

  - `Data.Transaction.CreditorAgent.PostalAddress.Country` (string)
    Nation with its own government.
    Example: "CL"

  - `Data.Transaction.CreditorAgent.PostalAddress.CountrySubDivision` (string)
    Identifies a subdivision of a country such as state, region, county.
    Example: "REGION METROPOLITANA"

  - `Data.Transaction.CreditorAgent.PostalAddress.Department` (string)
    Identification of a division of a large organisation or building.
    Example: "OFICINA SANTIAGO CENTRO"

  - `Data.Transaction.CreditorAgent.PostalAddress.PostCode` (string)
    Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
    Example: "8340422"

  - `Data.Transaction.CreditorAgent.PostalAddress.StreetName` (string)
    Name of a street or thoroughfare.
    Example: "CALLE MONEDA"

  - `Data.Transaction.CreditorAgent.PostalAddress.SubDepartment` (string)
    Identification of a sub-division of a large organisation or building.
    Example: "BANCA PERSONAS"

  - `Data.Transaction.CreditorAgent.PostalAddress.TownName` (string)
    Name of a built-up area, with defined boundaries, and a local government.
    Example: "SANTIAGO"

  - `Data.Transaction.CurrencyExchange` (object)
    Set of elements used to provide details on the currency exchange.

  - `Data.Transaction.CurrencyExchange.ExchangeRate` (string, required)
    Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
    Example: "691.907186"

  - `Data.Transaction.CurrencyExchange.SourceCurrency` (string, required)
    Currency from which an amount is to be converted in a currency conversion.
    Example: "USD"

  - `Data.Transaction.CurrencyExchange.ContractIdentification` (string)
    Unique identification to unambiguously identify the foreign exchange contract.
    Example: "84783113"

  - `Data.Transaction.CurrencyExchange.QuotationDate` (string)
    Date and time at which an exchange rate is quoted.
    Example: "2019-05-15T09:45:00-0400"

  - `Data.Transaction.CurrencyExchange.TargetCurrency` (string)
    Currency into which an amount is to be converted in a currency conversion.
    Example: "CLP"

  - `Data.Transaction.CurrencyExchange.UnitCurrency` (string)
    Currency in which the rate of exchange is expressed in a currency exchange. In the example 1USD = xxxCLP, the unit currency is USD.
    Example: "USD"

  - `Data.Transaction.CurrencyExchange.InstructedAmount` (object)
    Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

  - `Data.Transaction.DebtorAccount` (object)
    Unambiguous identification of the account of the debtor, in the case of a credit transaction.

  - `Data.Transaction.DebtorAgent` (object)
    Financial institution servicing an account for the debtor.

  - `Data.Transaction.MerchantDetails` (object)
    Details of the merchant involved in the transaction.

  - `Data.Transaction.MerchantDetails.MerchantCategoryCode` (string)
    Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
    Example: "2741"

  - `Data.Transaction.MerchantDetails.MerchantName` (string)
    Name by which the merchant is known.
    Example: "MI COMERCIO"

  - `Data.Transaction.ProprietaryBankTransactionCode` (object)
    Set of elements to fully identify a proprietary bank transaction code.

  - `Data.Transaction.ProprietaryBankTransactionCode.Code` (string, required)
    Proprietary bank transaction code to identify the underlying transaction.
    Example: "TRANSFERENCIA"

  - `Data.Transaction.ProprietaryBankTransactionCode.Issuer` (string)
    Identification of the issuer of the proprietary bank transaction code.
    Example: "DEMO BANK"

  - `Data.Transaction.SupplementaryData` (array)
    Additional information that can not be captured in the structured fields and/or any other specific block.

  - `AdditionalInformation` (string, required)
    This field can be used to display relevant information specific to the response, for instance indicating that the  field is incomplete.

  - `Error` (object, required)
    Object with the error details, used when . If  this field will be null. You can read a complete explanation of this object visiting [this link](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Internal system code that identifies the error.
    Example: "E201"

  - `Error.Type` (string)
    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"

  - `Error.Description` (string)
    Description associated with the error code.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string, required)
    in sync requests.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status. When making async requests it will always return .
    Example: "OK"

  - `Data` (object, required)
    in async requests.

  - `AdditionalInformation` (string, required)
    Operation message, can be used to display additional information.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    in async requests.

  - `LifeSpan` (string, required)
    Max estimated delivery date for async requests, in ISO 8601 date format, UTC timezone.
    Example: "2017-07-22T00:00:00-0400"