Open Bank Project
|
OBP v4.0.0 filtered by tag: Transaction-Metadata, Counterparty-Metadata (45 APIs)
API Host: https://apisandbox.strings.my
BankAccountsViewsCounterpartiesTransactionsGet Counterparty by Counterparty Id (Explicit)Information returned about the Counterparty specified by COUNTERPARTY_ID: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getExplictCounterpartyById
Add Corporate Location to CounterpartyAdd the geolocation of the counterparty's registered address Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyCorporateLocation
Add Counterparty More InfoAdd a description of the counter party from the perpestive of the account e.g. My dentist Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyMoreInfo
Add Open Corporates URL to CounterpartyAdd open corporates url to other bank account Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyOpenCorporatesUrl
Add image url to other bank accountAdd a url that points to the logo of the counterparty Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyImageUrl
Add physical location to other bank accountAdd geocoordinates of the counterparty's main location Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyPhysicalLocation
Add public alias to other bank accountCreates the public alias for the other account OTHER_ACCOUNT_ID. Authentication is Optional Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyPublicAlias
Add url to other bank accountA url which represents the counterparty (home page url etc.) Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyUrl
Create Other Account Private AliasCreates a private alias for the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addOtherAccountPrivateAlias
Delete Counterparty Corporate LocationDelete corporate location of other bank account. Delete the geolocation of the counterparty's registered address Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyCorporateLocation
Delete Counterparty Image URLDelete image url of other bank account Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyImageUrl
Delete Counterparty Open Corporates URLDelete open corporate url of other bank account Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyOpenCorporatesUrl
Delete Counterparty Physical LocationDelete physical location of other bank account Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPhysicalLocation
Delete Counterparty Private AliasDeletes the private alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPrivateAlias
Delete Counterparty Public AliasDeletes the public alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPublicAlias
Delete more info of other bank accountAuthentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyMoreInfo
Delete url of other bank accountAuthentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyUrl
Get Other Account MetadataGet metadata of one other account. Authentication via OAuth is required if the view is not public. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountMetadata
Get Other Account Private AliasReturns the private alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountPrivateAlias
Get public alias of other bank accountReturns the public alias of the other account OTHER_ACCOUNT_ID. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getCounterpartyPublicAlias
Update Counterparty Corporate LocationUpdate the geolocation of the counterparty's registered address Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyCorporateLocation
Update Counterparty Image UrlUpdate the url that points to the logo of the counterparty Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyImageUrl
Update Counterparty More InfoUpdate the more info description of the counter party from the perpestive of the account e.g. My dentist Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyMoreInfo
Update Counterparty Physical LocationUpdate geocoordinates of the counterparty's main location Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPhysicalLocation
Update Counterparty Private AliasUpdates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPrivateAlias
Update Open Corporates Url of CounterpartyUpdate open corporate url of other bank account Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyOpenCorporatesUrl
Update public alias of other bank accountUpdates the public alias of the other account / counterparty OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPublicAlias
Update url of other bank accountA url which represents the counterparty (home page url etc.) Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyUrl
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
|