Open Bank Project
|
OBP v4.0.0 filtered by tag: Counterparty, Counterparty-Metadata (34 APIs)
API Host: https://api.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsCreate Counterparty (Explicit)Create Counterparty (Explicit) for an Account. In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view name : the human readable name (e.g. Piano teacher, Miss Nipa) description : the human readable name (e.g. Piano teacher, Miss Nipa) bank_routing_scheme : eg: bankId or bankCode or any other strings bank_routing_address : eg: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: other_account_secondary_routing_scheme : eg: IBan or any other strings other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty. other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode. other_branch_routing_address : eg: is_beneficiary : must be set to bespoke: It supports a list of key-value, you can add it to the counterparty. bespoke.key : any info-key you want to add to this counterparty bespoke.value : any info-value you want to add to this counterparty The view specified by VIEW_ID must have the canAddCounterparty permission A minimal example for TransactionRequestType == COUNTERPARTY A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by createCounterparty
Create Counterparty (Explicit) for any accountCreate Counterparty (Explicit) for any Account. In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view name : the human readable name (e.g. Piano teacher, Miss Nipa) description : the human readable name (e.g. Piano teacher, Miss Nipa) bank_routing_scheme : eg: bankId or bankCode or any other strings bank_routing_address : eg: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: other_account_secondary_routing_scheme : eg: IBan or any other strings other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty. other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode. other_branch_routing_address : eg: is_beneficiary : must be set to bespoke: It supports a list of key-value, you can add it to the counterparty. bespoke.key : any info-key you want to add to this counterparty bespoke.value : any info-value you want to add to this counterparty The view specified by VIEW_ID must have the canAddCounterparty permission A minimal example for TransactionRequestType == COUNTERPARTY A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createCounterpartyForAnyAccount
Get Counterparties (Explicit)Get the Counterparties (Explicit) for the account / view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.2.0 by getExplictCounterpartiesForAccount
Get 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 OBPv2.2.0 by getExplictCounterpartyById
Get Other Account by IdReturns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountByIdForBankAccount
Get Other Accounts of one AccountReturns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is required if the view VIEW_ID is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountsForBankAccount
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
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
|