{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"api.ttk.com.mk","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties/{COUNTERPARTY_ID}":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Counterparty-Metadata","New-Style"],"summary":"Get Counterparty by Counterparty Id (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Information returned about the Counterparty specified by COUNTERPARTY_ID:
Authentication is Mandatory
","operationId":"OBPv4.0.0-getExplictCounterpartyById","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"COUNTERPARTY_ID","description":"the counterparty id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Metadata","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get metadata of one other account.
Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
","operationId":"OBPv1.2.1-getOtherAccountMetadata","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountMetadataJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/corporate_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Corporate Location to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add the geolocation of the counterparty's registered address
Authentication is Mandatory
","operationId":"OBPv1.2.1-addCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the geolocation of the counterparty's registered address
Authentication is Mandatory
","operationId":"OBPv1.2.1-updateCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/image_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Image URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete image url of other bank account
Authentication is Optional
","operationId":"OBPv1.2.1-deleteCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty","New-Style"],"summary":"Add image url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add a url that points to the logo of the counterparty
Authentication is Mandatory
","operationId":"OBPv1.2.1-addCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Image Url","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the url that points to the logo of the counterparty
Authentication is Optional
","operationId":"OBPv1.2.1-updateCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/more_info":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete more info of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty","New-Style"],"summary":"Add Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add a description of the counter party from the perpestive of the account e.g. My dentist
Authentication is Mandatory
","operationId":"OBPv1.2.1-addCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist
Authentication is Mandatory
","operationId":"OBPv1.2.1-updateCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/open_corporates_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Open Corporates URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete open corporate url of other bank account
Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty","New-Style"],"summary":"Add Open Corporates URL to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add open corporates url to other bank account
Authentication is Optional
","operationId":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Open Corporates Url of Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update open corporate url of other bank account
Authentication is Mandatory
","operationId":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/physical_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete physical location of other bank account
Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add physical location to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Add geocoordinates of the counterparty's main location
Authentication is Mandatory
","operationId":"OBPv1.2.1-addCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update geocoordinates of the counterparty's main location
Authentication is Mandatory
","operationId":"OBPv1.2.1-updateCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete url of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty","New-Style"],"summary":"Add url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
","operationId":"OBPv1.2.1-addCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update url of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
","operationId":"OBPv1.2.1-updateCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/private_alias":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Returns the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Creates a private alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Deletes the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Returns the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is Mandatory if the view is not public.
Creates the public alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
the public alias was deleted.
The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.
","operationId":"OBPv1.2.1-addCounterpartyPublicAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update public alias of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Returns 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
","operationId":"OBPv1.2.1-getCommentsForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Add comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Posts 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
","operationId":"OBPv1.2.1-addCommentForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionCommentJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionCommentJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/comments/{COMMENT_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Delete comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete 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
","operationId":"OBPv1.2.1-deleteCommentForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"COMMENT_ID","description":"The comment id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images":{"get":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Get images","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
","operationId":"OBPv1.2.1-getImagesForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImagesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Add an image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
Authentication is Mandatory
The image is linked with the user.
","operationId":"OBPv1.2.1-addImageForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionImageJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionImageJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImageJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images/{IMAGE_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Delete an image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes 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
","operationId":"OBPv1.2.1-deleteImageForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"IMAGE_ID","description":"The image id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/narrative":{"delete":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Delete narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
","operationId":"OBPv1.2.1-deleteTransactionNarrative","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Get narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns 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
","operationId":"OBPv1.2.1-getTransactionNarrative","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Add narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Creates a description of the transaction TRANSACTION_ID.
Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).
Authentication is Optional
Authentication is required if the view is not public.
Updates the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
Authentication is Optional
","operationId":"OBPv1.2.1-updateTransactionNarrative","parameters":[{"in":"body","name":"body","description":"TransactionNarrativeJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags":{"get":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Get tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
Authentication is Optional
","operationId":"OBPv1.2.1-getTagsForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Add a tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Posts 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.
","operationId":"OBPv1.2.1-addTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionTagJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionTagJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags/{TAG_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Delete a tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the tag TAG_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 tag.
Authentication is Optional
","operationId":"OBPv1.2.1-deleteTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TAG_ID","description":"The tag id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorNoViewPermission"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/where":{"delete":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Delete where tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes 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.
","operationId":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Get where tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
Authentication is Optional
","operationId":"OBPv1.2.1-getWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionWhereJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Add where tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
","operationId":"OBPv1.2.1-addWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Transaction-Metadata","Transaction","New-Style"],"summary":"Update where tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
","operationId":"OBPv1.2.1-updateWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. "}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission: "}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"CounterpartyMetadataJson":{"required":["public_alias","physical_location","image_url","private_alias","url","more_info","corporate_location","open_corporates_url"],"properties":{"public_alias":{"type":"string","example":"String"},"physical_location":{"$ref":"#/definitions/LocationJsonV210"},"image_url":{"type":"string","example":"String"},"private_alias":{"type":"string","example":"String"},"url":{"type":"string","example":"String"},"more_info":{"type":"string","example":"String"},"corporate_location":{"$ref":"#/definitions/LocationJsonV210"},"open_corporates_url":{"type":"string","example":"String"}}},"CorporateLocationJSON":{"required":["corporate_location"],"properties":{"corporate_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"OpenCorporateUrlJSON":{"required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"string","example":"String"}}},"ImageUrlJSON":{"required":["image_URL"],"properties":{"image_URL":{"type":"string","example":"String"}}},"PostTransactionCommentJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"PostTransactionImageJSON":{"required":["label","URL"],"properties":{"label":{"type":"string","example":"String"},"URL":{"type":"string","example":"String"}}},"PostTransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationPlainJSON"}}},"MoreInfoJSON":{"required":["more_info"],"properties":{"more_info":{"type":"string","example":"String"}}},"TransactionTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"CounterpartyWithMetadataJson400":{"required":["other_account_routing_address","other_account_routing_scheme","created_by_user_id","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","this_account_id","this_view_id","currency","metadata","other_bank_routing_address","this_bank_id","counterparty_id","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"36f8a9e6-c2b1-407a-8bd0-421b7119307e"},"other_account_routing_scheme":{"type":"string","example":"OBP"},"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"currency":{"type":"string","example":"EUR"},"metadata":{"$ref":"#/definitions/CounterpartyMetadataJson"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"TransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationJSONV121"}}},"AliasJSON":{"required":["alias"],"properties":{"alias":{"type":"string","example":"String"}}},"TransactionImagesJSON":{"required":["images"],"properties":{"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}}}},"PostTransactionTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"OtherAccountMetadataJSON":{"required":["public_alias","image_URL","physical_location","private_alias","URL","more_info","corporate_location","open_corporates_URL"],"properties":{"public_alias":{"type":"string","example":"NONE"},"image_URL":{"type":"string","example":"www.openbankproject.com"},"physical_location":{"$ref":"#/definitions/LocationJSONV121"},"private_alias":{"type":"string","example":"NONE"},"URL":{"type":"string","example":"www.openbankproject.com"},"more_info":{"type":"string","example":"www.openbankproject.com"},"corporate_location":{"$ref":"#/definitions/LocationJSONV121"},"open_corporates_URL":{"type":"string","example":"www.openbankproject.com"}}},"PostCounterpartyBespokeJson":{"required":["key","value"],"properties":{"key":{"type":"string","example":"englishName"},"value":{"type":"string","example":"english Name"}}},"UrlJSON":{"required":["URL"],"properties":{"URL":{"type":"string","example":"String"}}},"TransactionCommentJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"LocationJsonV210":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV210"}}},"TransactionImageJSON":{"required":["URL","label","id","date","user"],"properties":{"URL":{"type":"string","example":"www.openbankproject.com"},"label":{"type":"string","example":"NONE"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"UserJSONV210":{"required":["id","provider","username"],"properties":{"id":{"type":"string","example":"123"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"username":{"type":"string","example":"felixsmith"}}},"TransactionCommentsJSON":{"required":["comments"],"properties":{"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"TransactionNarrativeJSON":{"required":["narrative"],"properties":{"narrative":{"type":"string","example":"narative"}}},"PhysicalLocationJSON":{"required":["physical_location"],"properties":{"physical_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"1.231"},"longitude":{"type":"number","format":"double","example":"1.231"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"LocationPlainJSON":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"1.532"},"longitude":{"type":"number","format":"double","example":"1.535"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}}}}