GoCardlessDeveloper Docs
Create a sandbox account

Account Transactions Output#

View as Markdown

Account Transactions Output#

This section contains key descriptions for transactions.

KEYTYPEOPTIONALDESCRIPTION
additionalDataStructuredObjectOptionalAn umbrella datapoint used for information that is outside of Berlin Group specification, such as bank- or country-specific fields
additionalInformationMax512TextOptionalMight be used by the financial institution to transport additional transaction related information
additionalInformation StructuredMax280TextConditionalIs used if and only if the bookingStatus entry equals "information"
balanceAfterTransactionBalanceOptionalThis is the balance after this transaction. Recommended balance type is interimBooked.
bankTransactionCodeMax32TextOptionalBank 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
bookingDateISODateOptionalThe date when an entry is posted to an account on the financial institutions books.
bookingDateTimeISODateOptionalThe date and time when an entry is posted to an account on the financial institutions books.
checkIdMax48TextOptionalIdentification of a Cheque
creditorAccountAccount ReferenceConditional
creditorAgentBICFIOptional
creditorIdMax35TextOptionalIdentification of Creditors, e.g. a SEPA Creditor ID
creditorNameMax176TextOptionalName of the creditor if a "Debited" transaction
currencyExchangeCurrencyExchange can be either a list or a dictOptional
debtorAccountAccount ReferenceConditional
debtorAgentBICFIOptional
debtorNameMax176TextOptionalName of the debtor if a "Credited" transaction
endToEndIdMax35TextOptionalUnique end to end ID
entryReferenceMax128TextOptionalIs the identification of the transaction as used for reference given by financial institution.
internalTransactionIdMax32TextOptionalTransaction identifier given by Gocardless
mandateIdMax48TextOptionalIdentification of Mandates, e.g. a SEPA Mandate ID
merchantCategoryCodeMax4TextOptionalMerchant category code as defined by card issuer
proprietaryBank TransactionCodeMax64TextOptionalProprietary bank transaction code as used within a community or within an financial institution
purposeCodePurpose CodeConditional
remittanceInformation StructuredMax560TextOptionalReference as contained in the structured remittance reference structure
remittanceInformation StructuredArrayArray of RemittanceOptionalReference as contained in the structured remittance reference structure
**remittanceInformation Unstructured **Max560TextOptional
**remittanceInformation UnstructuredArray **Array of Max560TextOptional
transactionAmountAmountMandatoryThe amount of the transaction as billed to the account, an object containing: amount Float currency Max3Text
transactionIdMax256TextOptionalTransaction identifier provided by the financial institution
ultimateCreditorMax128TextOptional
ultimateDebtorMax96TextOptional
valueDateISODateOptionalThe Date at which assets become available to the account owner in case of a credit
valueDateTimeISODateOptionalThe date and time at which assets become available to the account owner in case of a credit

What's next?#