Skip to main content

Deposittransaction

Represents the action performed on an Deposit Account after which the account's amount changes its value.

accountBalances object

The balances changed within a transaction.

totalBalancenumber

The running balance owed by deposit

adjustmentTransactionKeystring

The key of the deposit transaction where the adjustment for this transaction was made (if any adjustment was involved)

affectedAmounts object

The amounts affected after completing the deposit transaction

feesAmountnumber

Amount of fees involved in a transaction that affects an account with positive balance

fractionAmountnumber

In the case of an LOAN_FRACTION_BOUGHT this represent the fraction amount which was bought from another investor

fundsAmountnumber

Balance change amount involved in a transaction that affects an account with positive balance

interestAmountnumber

Amount of interest involved in a transaction that affects an account with positive balance

overdraftAmountnumber

The amount of money that was added/subtracted from the account by this transaction as overdraft

overdraftFeesAmountnumber

Fees amount involved in a transaction that affects an overdraft

overdraftInterestAmountnumber

Interest amount involved in a transaction that affects an overdraft

technicalOverdraftAmountnumber

The amount of money that was added/subtracted from the account by this transaction as technical overdraft

technicalOverdraftInterestAmountnumber

The amount of money that was added/subtracted from the account by this transaction as technical overdraft interest

amountnumber

How much was added/removed in account

blockIdstring

The block fund id associated with the transaction

bookingDatestring<date-time>

The date when corresponding JE is booked (as Organization Time)

Example: 2016-09-06T13:37:50+03:00
branchKeystring

The branch where the transaction was performed

cardTransaction object

A card transaction entry which will have a corresponding a financial transaction performed.

advicebooleanrequired

Whether the given request should be accepted without balance validations.

amountnumberrequired

The amount of money to be withdrawn in the financial transaction.

cardAcceptor object

The details of the card acceptor (merchant) in a transaction hold.

citystring

The city in which the card acceptor has the business.

countrystring

The country in which the card acceptor has the business.

mccinteger<int32>

The Merchant Category Code of the card acceptor.

namestring

The name of the card acceptor.

statestring

The state in which the card acceptor has the business.

streetstring

The street in which the card acceptor has the business.

zipstring

The ZIP code of the location in which the card acceptor has the business.

cardTokenstring

The reference token of the card.

currencyCodestring

The ISO currency code in which the card reversal transaction is posted. The amounts are stored in the base currency, but the transaction can be created with a foreign currency.

encodedKeystring

The encoded key of the entity, generated, globally unique

externalAuthorizationReferenceIdstring

The external authorization hold reference ID, which relates this card transaction to a previous authorization hold.

externalReferenceIdstringrequired

The external reference ID to be used to reference the card transaction in subsequent requests.

userTransactionTimestring

The formatted time at which the user made this card transaction.

centreKeystring

The center where the transaction was performed

creationDatestring<date-time>

The date when this deposit transaction was created

Example: 2016-09-06T13:37:50+03:00
currencyCodestring

The currency in which this transaction was posted

customFieldsArchivedboolean

Whether the custom fields of the transaction are archived

encodedKeystring

The encoded key of the deposit transaction, auto generated, unique

externalIdstring

The external id of the deposit transaction, customizable, unique

fees object[]

All the amounts that have been applied or paid within this transaction and involved predefined fees

  • Array [
  • amountnumber

    The amount of the fee that was applied/paid in the transaction for the given predefined fee.

    namestring

    The name of the predefined fee

    predefinedFeeKeystringrequired

    The encoded key of the predefined fee, auto generated, unique

    taxAmountnumber

    The amount of the taxes on fee that was applied/paid in the transaction.

    triggerstring

    Shows the event that will trigger a fee

    Possible values: [MANUAL, MONTHLY_FEE, ARBITRARY]

  • ]
  • holdExternalReferenceIdstring

    The external id of an account authorization hold

    idstring

    The id of the deposit transaction, auto generated, unique

    interestAccruedAmounts object

    Represents the accrued interest amounts for an Interest Applied deposit transaction.

    interestAccruednumber

    The amount of positive interest accrued since last interest application/activation date and applied within Interest Applied transaction

    negativeInterestAccruednumber

    The amount of negative interest accrued since last interest application/activation date and applied within Interest Applied transaction

    overdraftInterestAccruednumber

    The amount of overdraft interest accrued since last interest application/activation date and applied within Interest Applied transaction

    technicalOverdraftInterestAccruednumber

    The amount of technical overdraft interest accrued since last interest application/activation date and applied within Interest Applied transaction

    migrationEventKeystring

    The migration event encoded key associated with this deposit account. If this account was imported, track which 'migration event' they came from

    notesstring

    Extra notes about this deposit transaction

    originalTransactionKeystring

    The encodedKey of the transaction that was adjusted as part of this one. Available only for adjustment transactions

    parentAccountKeystring

    The key of the parent deposit account

    paymentDetails object

    The payment information including account identification details

    creditor object

    The details of the party for a transaction

    namestring

    The name of the party

    creditorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    creditorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    debtor object

    The details of the party for a transaction

    namestring

    The name of the party

    debtorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    debtorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    paymentIdentification object

    The payment identification details

    endToEndIdentificationstring

    Identifier assigned by the initiating party to the transaction

    instructionIdentificationstring

    Identifier of a payment instruction

    transactionIdentificationstring

    Identifier unique for a period assigned by the first initiating party to the transaction

    paymentTypeInformation object

    The information specifying the type of transaction

    serviceLevel object

    The rules under which the transaction should be processed

    codestring

    The code for a pre-agreed service or level of service between the parties

    remittanceInformation object

    The information specifying the payment items that are intended to settle

    structured object

    The information specifying the payment items that are intended to settle

    creditorReferenceInformation object

    Represents the reference to the underlying documents of the payment.

    referencestring

    The reference information of the creditor's underlying documents

    referenceIssuerstring

    The entity that assigns the reference type

    referenceTypestring

    The type of creditor reference

    unstructuredstring

    Information supplied to match the items of the payment in an unstructured form

    paymentOrderIdstring

    The payment order id of the deposit transaction, customizable

    taxes object

    The taxes applied within a transaction

    taxRatenumber

    The tax rate that was set or changed in this transaction

    terms object

    The deposit transaction terms

    interestSettings object

    The interest settings, holds all the properties regarding interests for the deposit account

    indexInterestRatenumber

    The value of the index interest rate set or changed in this transaction

    interestRatenumber

    The interest rate for the deposit account

    overdraftInterestSettings object

    Holds the deposit overdraft interest settings

    indexInterestRatenumber

    The value of the index interest rate set or changed in this transaction

    interestRatenumber

    The interest rate that was set or changed in this transaction. Used on product interest rate changes or interest tier switches

    overdraftSettings object

    Holds the deposit overdraft settings for a transaction

    overdraftLimitnumber

    The overdraft limit that was set or changed in this transaction

    tillKeystring

    The till key associated with this transaction

    transactionDetails object

    Contains the details about transaction including fields like transaction channel key and channel id

    transactionChannelIdstring

    The id of the transaction channel associated with the transaction details.

    transactionChannelKeystring

    The encoded key of the transaction channel associated with the transaction details.

    transferDetails object

    Represents the transfer details, such as the linked transaction key

    linkedDepositTransactionKeystring

    The key of the related deposit transaction

    linkedLoanTransactionKeystring

    The key of the related loan transaction

    typestring

    The type of the deposit transaction

    Possible values: [IMPORT, WRITE_OFF, WRITE_OFF_ADJUSTMENT, DEPOSIT, ADJUSTMENT, WITHDRAWAL, WITHDRAWAL_ADJUSTMENT, CARD_TRANSACTION_REVERSAL, CARD_TRANSACTION_REVERSAL_ADJUSTMENT, TRANSFER, TRANSFER_ADJUSTMENT, FEE_APPLIED, FEE_ADJUSTED, FEES_DUE_REDUCED, INTEREST_APPLIED, INTEREST_APPLIED_ADJUSTMENT, NET_DIFF_INTEREST, PROFIT_APPLIED, PROFIT_APPLIED_ADJUSTMENT, FEE_REDUCTION_ADJUSTMENT, WITHHOLDING_TAX, WITHHOLDING_TAX_ADJUSTMENT, INTEREST_RATE_CHANGED, OVERDRAFT_INTEREST_RATE_CHANGED, OVERDRAFT_LIMIT_CHANGED, BRANCH_CHANGED, ACCOUNT_HOLDER_CHANGED, LOAN_FUNDED, LOAN_FUNDED_ADJUSTMENT, LOAN_REPAID, LOAN_REPAID_ADJUSTMENT, LOAN_FRACTION_BOUGHT, LOAN_FRACTION_BOUGHT_ADJUSTMENT, LOAN_FRACTION_SOLD, LOAN_FRACTION_SOLD_ADJUSTMENT, SEIZED_AMOUNT]

    userKeystring

    The person that performed the transaction

    valueDatestring<date-time>

    Date of the entry (eg date of repayment or disbursal, etc.) (as Organization Time)

    Example: 2016-09-06T13:37:50+03:00
    Deposittransaction
    {
    "accountBalances": {
    "totalBalance": 0
    },
    "adjustmentTransactionKey": "string",
    "affectedAmounts": {
    "feesAmount": 0,
    "fractionAmount": 0,
    "fundsAmount": 0,
    "interestAmount": 0,
    "overdraftAmount": 0,
    "overdraftFeesAmount": 0,
    "overdraftInterestAmount": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAmount": 0
    },
    "amount": 0,
    "blockId": "string",
    "bookingDate": "2016-09-06T13:37:50+03:00",
    "branchKey": "string",
    "cardTransaction": {
    "advice": true,
    "amount": 0,
    "cardAcceptor": {
    "city": "string",
    "country": "string",
    "mcc": 0,
    "name": "string",
    "state": "string",
    "street": "string",
    "zip": "string"
    },
    "cardToken": "string",
    "currencyCode": "string",
    "encodedKey": "string",
    "externalAuthorizationReferenceId": "string",
    "externalReferenceId": "string",
    "userTransactionTime": "string"
    },
    "centreKey": "string",
    "creationDate": "2016-09-06T13:37:50+03:00",
    "currencyCode": "string",
    "customFieldsArchived": true,
    "encodedKey": "string",
    "externalId": "string",
    "fees": [
    {
    "amount": 0,
    "name": "string",
    "predefinedFeeKey": "string",
    "taxAmount": 0,
    "trigger": "MANUAL"
    }
    ],
    "holdExternalReferenceId": "string",
    "id": "string",
    "interestAccruedAmounts": {
    "interestAccrued": 0,
    "negativeInterestAccrued": 0,
    "overdraftInterestAccrued": 0,
    "technicalOverdraftInterestAccrued": 0
    },
    "migrationEventKey": "string",
    "notes": "string",
    "originalTransactionKey": "string",
    "parentAccountKey": "string",
    "paymentDetails": {
    "creditor": {
    "name": "string"
    },
    "creditorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "creditorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "debtor": {
    "name": "string"
    },
    "debtorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "debtorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "paymentIdentification": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string"
    },
    "paymentTypeInformation": {
    "serviceLevel": {
    "code": "string"
    }
    },
    "remittanceInformation": {
    "structured": {
    "creditorReferenceInformation": {
    "reference": "string",
    "referenceIssuer": "string",
    "referenceType": "string"
    }
    },
    "unstructured": "string"
    }
    },
    "paymentOrderId": "string",
    "taxes": {
    "taxRate": 0
    },
    "terms": {
    "interestSettings": {
    "indexInterestRate": 0,
    "interestRate": 0
    },
    "overdraftInterestSettings": {
    "indexInterestRate": 0,
    "interestRate": 0
    },
    "overdraftSettings": {
    "overdraftLimit": 0
    }
    },
    "tillKey": "string",
    "transactionDetails": {
    "transactionChannelId": "string",
    "transactionChannelKey": "string"
    },
    "transferDetails": {
    "linkedDepositTransactionKey": "string",
    "linkedLoanTransactionKey": "string"
    },
    "type": "IMPORT",
    "userKey": "string",
    "valueDate": "2016-09-06T13:37:50+03:00"
    }