Bank Account Data - Account Transactions Output
Account Transactions Output
This section explains key descriptions for transactions.
Find available data points for each bank here.
KEY | TYPE | OPTIONAL | DESCRIPTION |
|---|---|---|---|
additionalDataStructured | Object | Optional | An umbrella datapoint used for information that is outside of Berlin Group specification, such as bank- or country-specific fields |
additionalInformation | Max512Text | Optional | Might be used by the financial institution to transport additional transaction related information |
additionalInformation Structured | Max280Text | Conditional | Is used if and only if the bookingStatus entry equals "information" |
balanceAfterTransaction | Balance | Optional | This is the balance after this transaction. Recommended balance type is interimBooked. |
bankTransactionCode | Max32Text | Optional | Bank transaction code as used by the financial institution and using the sub elements of this structured code defined by ISO20022. For standing order reports the following codes are applicable: "PMNT-ICDT-STDO" for credit transfers, "PMNT-IRCT-STDO" for instant credit transfers, "PMNT-ICDT-XBST" for cross-border credit transfers, "PMNT-IRCT-XBST" for cross-border real time credit transfers, "PMNT-MCOP-OTHR" for specific standing orders which have a dynamical amount to move left funds e.g. on month end to a saving account |
bookingDate | ISODate | Optional | The date when an entry is posted to an account on the financial institutions books. |
bookingDateTime | ISODate | Optional | The date and time when an entry is posted to an account on the financial institutions books. |
checkId | Max48Text | Optional | Identification of a Cheque |
creditorAccount | Account Reference | Conditional |
|
creditorAgent | BICFI | Optional |
|
creditorId | Max35Text | Optional | Identification of Creditors, e.g. a SEPA Creditor ID |
creditorName | Max176Text | Optional | Name of the creditor if a "Debited" transaction |
currencyExchange | Array of Report Exchange Rate | Optional |
|
debtorAccount | Account Reference | Conditional |
|
debtorAgent | BICFI | Optional |
|
debtorName | Max176Text | Optional | Name of the debtor if a "Credited" transaction |
endToEndId | Max35Text | Optional | Unique end to end ID |
entryReference | Max128Text | Optional | Is the identification of the transaction as used for reference given by financial institution. |
internalTransactionId | Max32Text | Optional | Transaction identifier given by Gocardless |
mandateId | Max48Text | Optional | Identification of Mandates, e.g. a SEPA Mandate ID |
merchantCategoryCode | Max4Text | Optional | Merchant category code as defined by card issuer |
proprietaryBank TransactionCode | Max64Text | Optional | Proprietary bank transaction code as used within a community or within an financial institution |
purposeCode | Purpose Code | Conditional |
|
remittanceInformation Structured | Max560Text | Optional | Reference as contained in the structured remittance reference structure |
remittanceInformation StructuredArray | Array of Remittance | Optional | Reference as contained in the structured remittance reference structure |
remittanceInformation Unstructured | Max560Text | Optional |
|
remittanceInformation UnstructuredArray | Array of Max560Text | Optional |
|
transactionAmount | Amount | Mandatory | The amount of the transaction as billed to the account, an object containing: amount Float currency Max3Text |
transactionId | Max256Text | Optional | Unique transaction identifier given by financial institution |
ultimateCreditor | Max128Text | Optional |
|
ultimateDebtor | Max96Text | Optional |
|
valueDate | ISODate | Optional | The Date at which assets become available to the account owner in case of a credit |
valueDateTime | ISODate | Optional | The date and time at which assets become available to the account owner in case of a credit |