Open Bank Project
|
OBP v4.0.0 filtered by tag: Transaction, Transaction-Metadata (30 APIs)
API Host: https://api.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsCreate Transaction AttributeCreate Transaction Attribute The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createTransactionAttribute
Create or Update Transaction Attribute DefinitionCreate or Update Transaction Attribute Definition The category field must be Transaction The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateTransactionAttributeDefinition
Delete Transaction Attribute DefinitionDelete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteTransactionAttributeDefinition
Delete Transaction CascadeDelete a Transaction Cascade specified by TRANSACTION_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteTransactionCascade
Get Firehose Transactions for AccountGet Transactions for an Account that has a firehose View. Allows bulk access to an account's transactions. To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call. For VIEW_ID try 'owner'
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.0.0 by getFirehoseTransactionsForBankAccount
Get Other Account of TransactionGet other account of a transaction. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getOtherAccountForTransaction
Get Transaction Attribute By IdGet Transaction Attribute By Id Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getTransactionAttributeById
Get Transaction Attribute DefinitionGet Transaction Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getTransactionAttributeDefinition
Get Transaction AttributesGet Transaction Attributes Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getTransactionAttributes
Get Transaction by IdReturns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getTransactionByIdForBankAccount
Get Transactions for Account (Core)Returns transactions list (Core info) of the account specified by ACCOUNT_ID. Authentication is Mandatory Possible custom url parameters for pagination:
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getCoreTransactionsForBankAccount
Get Transactions for Account (Full)Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID). Authentication is Optional Authentication is required if the view is not public. Possible custom headers for pagination:
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getTransactionsForBankAccount
Update Transaction AttributeUpdate Transaction Attribute Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by updateTransactionAttribute
Add a tagPosts a tag about a transaction TRANSACTION_ID on a view VIEW_ID. Authentication is Mandatory Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by addTagForViewOnTransaction
Add an imagePosts an image about a transaction TRANSACTION_ID on a view VIEW_ID. Authentication is Mandatory The image is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by addImageForViewOnTransaction
Add commentPosts a comment about a transaction TRANSACTION_ID on a view VIEW_ID. ${authenticationRequiredMessage(false)} Authentication is required since the comment is linked with the user. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by addCommentForViewOnTransaction
Add narrativeCreates a description of the transaction TRANSACTION_ID. Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by addTransactionNarrative
Add where tagCreates a "where" Geo tag on a transaction TRANSACTION_ID in a view. Authentication is Mandatory The geo tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by addWhereTagForViewOnTransaction
Delete a tagDeletes the tag TAG_ID about the transaction TRANSACTION_ID made on view. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteTagForViewOnTransaction
Delete an imageDeletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view. Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteImageForViewOnTransaction
Delete commentDelete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view. Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteCommentForViewOnTransaction
Delete narrativeDeletes the description of the transaction TRANSACTION_ID. Authentication via OAuth is required if the view is not public. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteTransactionNarrative
Delete where tagDeletes the where tag of the transaction TRANSACTION_ID made on view. Authentication is Mandatory The user must either have owner privileges for this account, or must be the user that posted the geo tag. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by deleteWhereTagForViewOnTransaction
Get commentsReturns the transaction TRANSACTION_ID comments made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getCommentsForViewOnTransaction
Get imagesReturns the transaction TRANSACTION_ID images made on a view (VIEW_ID). Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getImagesForViewOnTransaction
Get narrativeReturns the account owner description of the transaction moderated by the view. Authentication via OAuth is required if the view is not public. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getTransactionNarrative
Get tagsReturns the transaction TRANSACTION_ID tags made on a view (VIEW_ID). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getTagsForViewOnTransaction
Get where tagReturns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by getWhereTagForViewOnTransaction
Update narrativeUpdates the description of the transaction TRANSACTION_ID. Authentication via OAuth is required if the view is not public. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by updateTransactionNarrative
Update where tagUpdates the "where" Geo tag on a transaction TRANSACTION_ID in a view. Authentication is Mandatory The geo tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by updateWhereTagForViewOnTransaction
|