{"resource_docs":[{"operation_id":"OBPv1.2.1-deleteTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","summary":"Delete a Transaction Tag","description":"
Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account,
\nor must be the user that posted the tag.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\nAuthentication via OAuth is required. The user must either have owner privileges for this account, \nor must be the user that posted the tag.\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TAG_ID](/glossary#tag_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTagsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getTagsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Get Transaction Tags","description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv2.1.0-getBranch","implemented_by":{"version":"OBPv2.1.0","function":"getBranch"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Get Bank Branch","description":"Returns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:
\nmeta.license.id and eta.license.name fields must not be empty.
Authentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n\n\ncity:
\ncountry: Germany
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nscheme: scheme value
\n\n","description_markdown":"Returns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:\n meta.license.id and eta.license.name fields must not be empty. \n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[BRANCH_ID](/glossary#): DERBY6\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"branch_routing":{"scheme":"BranchNumber","address":"678"}},"error_response_bodies":["OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty","OBP-50000: Unknown Error."],"tags":["Branch","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getCommentsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getCommentsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Get Transaction Comments","description":"Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID comments made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestFreeForm","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestFreeForm"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","summary":"Create Transaction Request (FREE_FORM)","description":"Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Initiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[FREE_FORM](/glossary#free_form): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"description":"This is a FREE_FORM Transaction Request"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateAnyTransactionRequest","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyMoreInfo"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Delete more info of other bank account","description":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting more info","More Info cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"addTransactionNarrative"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Add a Transaction Narrative","description":"Creates a description of the transaction TRANSACTION_ID.
\nNote: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
\nIf 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
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a description of the transaction TRANSACTION_ID.\n\nNote: Unlike other items of metadata, there is only one \"narrative\" per transaction accross all views.\nIf 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).\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv2.2.0-root","implemented_by":{"version":"OBPv2.2.0","function":"root"},"request_verb":"GET","request_url":"/obp/v2.2.0/root","summary":"Get API Info (root)","description":"Returns information about:
\nAuthentication is Optional
\nJSON response body fields:
\nconnector: connector
\n\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\n\n\n\n\n\n\n","description_markdown":"Returns information about:\n\n* API version\n* Hosted by information\n* Git Commit\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**connector**](/glossary#Connector): connector\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n\n[**hosted_by**](/glossary#hosted_by): \n\n\n\n[**organisation**](/glossary#organisation): \n\n\n\n[**organisation_website**](/glossary#organisation_website): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**version**](/glossary#version): \n\n\n\n[**version_status**](/glossary#version_status): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"version":"String","version_status":"String","git_commit":"String","connector":"String","hosted_by":{"organisation":"String","email":"String","phone":"String","organisation_website":"String"}},"error_response_bodies":["OBP-50000: Unknown Error.","no connector set"],"tags":["API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"git_commit":{"type":"string"},"hosted_by":{"type":"object","properties":{"organisation":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"organisation_website":{"type":"string"}}},"connector":{"type":"string"},"version":{"type":"string"},"version_status":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/root","connector_methods":[]},{"operation_id":"OBPv1.4.0-getCustomersMessages","implemented_by":{"version":"OBPv1.4.0","function":"getCustomersMessages"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/messages","summary":"Get Customer Messages for all Customers","description":"Get messages for the logged in customer
\nMessages sent to the currently authenticated user.
Authentication via OAuth is required.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndate: 2020-01-27
\nfrom_department: Open Bank
\nfrom_person: Tom
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nmessage: 123456
\n\n","description_markdown":"Get messages for the logged in customer\nMessages sent to the currently authenticated user.\n\nAuthentication via OAuth is required.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**messages**](/glossary#messages): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"messages":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","date":"1100-01-01T00:00:00Z","message":"String","from_department":"String","from_person":"String"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"from_person":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customer/messages","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountForTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountForTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","summary":"Get Other Account of Transaction","description":"Get other account of a transaction.
\nReturns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","description_markdown":"Get other account of a transaction.\nReturns details of the other party involved in the transaction, moderated by the [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Transaction","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPhysicalLocation"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Delete Counterparty Physical Location","description":"Delete physical location of other bank account
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete physical location of other bank account\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","Physical Location cannot be deleted","Delete not completed","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPublicAlias"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Update public alias of other bank account","description":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating the public alias","Alias cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv2.0.0-elasticSearchWarehouse","implemented_by":{"version":"OBPv2.0.0","function":"elasticSearchWarehouse"},"request_verb":"GET","request_url":"/obp/v2.0.0/search/warehouse","summary":"Search Warehouse Data Via Elasticsearch","description":"Search warehouse data via Elastic Search.
\nLogin is required.
\nCanSearchWarehouse entitlement is required to search warehouse data!
\nSend your email, name, project name and user_id to the admins to get access.
\nElastic (search) is used in the background. See links below for syntax.
\nparameters:
\nesType - elasticsearch type
\nsimple query:
\nq - plain_text_query
\ndf - default field to search
\nsort - field to sort on
\nsize - number of hits returned, default 10
\nfrom - show hits starting from
\njson query:
\nsource - JSON_query_(URL-escaped)
\nExample usage:
\nGET /search/warehouse/q=findThis
\nor:
\nGET /search/warehouse/source={"query":{"query_string":{"query":"findThis"}}}
\nNote!!
\nThe whole JSON query string MUST be URL-encoded:
\netc..
\nOnly q, source and esType are passed to Elastic
\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
\nYou can specify the esType thus: /search/warehouse/esType=type&q=a
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Search warehouse data via Elastic Search.\n\nLogin is required.\n\nCanSearchWarehouse entitlement is required to search warehouse data!\n\nSend your email, name, project name and user_id to the admins to get access.\n\nElastic (search) is used in the background. See links below for syntax.\n\n\nparameters:\n\n esType - elasticsearch type\n\n simple query:\n\n q - plain_text_query\n\n df - default field to search\n\n sort - field to sort on\n\n size - number of hits returned, default 10\n\n from - show hits starting from\n\n json query:\n\n source - JSON_query_(URL-escaped)\n\n\nExample usage:\n\nGET /search/warehouse/q=findThis\n\nor:\n\nGET /search/warehouse/source={\"query\":{\"query_string\":{\"query\":\"findThis\"}}}\n\n\nNote!!\n\nThe whole JSON query string MUST be URL-encoded:\n\n* For { use %7B\n* For } use %7D\n* For : use %3A\n* For \" use %22\n\netc..\n\n\n\nOnly q, source and esType are passed to Elastic\n\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html\n\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html\n\nYou can specify the esType thus: /search/warehouse/esType=type&q=a\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Data-Warehouse","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchWarehouse","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/search/warehouse","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"updateTransactionNarrative"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Update a Transaction Narrative","description":"Updates the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv2.0.0-getPermissionForUserForBankAccount","implemented_by":{"version":"OBPv2.0.0","function":"getPermissionForUserForBankAccount"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","summary":"Get Account access for User","description":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
\nAll url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
\nThe user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n\n","description_markdown":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.\nAll url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for USER_ID and PROVIDER.\n\nAuthentication is Mandatory\n\nThe user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"views":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account","User","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"getTransactionNarrative"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Get a Transaction Narrative","description":"Returns the account owner description of the transaction moderated by the view.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the account owner description of the transaction [moderated](#1_2_1-getViewsForBankAccount) by the view.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"narrative":"narative"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountMetadata","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountMetadata"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata","summary":"Get Other Account Metadata","description":"Get metadata of one other account.
\nReturns 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.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nmore_info: More information about this fee
\n\n\n\nprovider: ETHEREUM
\n\nuser:
\n","description_markdown":"Get metadata of one other account.\nReturns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","the view does not allow metadata access"],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycCheck","implemented_by":{"version":"OBPv2.0.0","function":"addKycCheck"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","summary":"Add KYC Check","description":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: true
\n\n\n","description_markdown":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_CHECK_ID](/glossary#kyc_check_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): true\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","example_request_body":{"customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"online_meeting","staff_user_id":"67876","staff_name":"Simon","satisfied":true,"comments":"String"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"staff_user_id":{"type":"string"},"staff_name":{"type":"string"},"comments":{"type":"string"},"how":{"type":"string"},"satisfied":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}},"roles":[{"role":"CanAddKycCheck","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-createAtm","implemented_by":{"version":"OBPv2.2.0","function":"createAtm"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks/BANK_ID/atms","summary":"Create ATM","description":"Create ATM for the Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nbank_id: gh.29.uk
\ncity:
\ncountry: Germany
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nJSON response body fields:
\n\nbank_id: gh.29.uk
\ncity:
\ncountry: Germany
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Create ATM for the Bank.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"id":"123","bank_id":"gh.29.uk","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"success_response_body":{"id":"123","bank_id":"gh.29.uk","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["ATM","Old-Style"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"bank_id":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"roles":[{"role":"CanCreateAtm","requires_bank_id":true},{"role":"CanCreateAtmAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/atms","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountsForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountsForBankAccount"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","summary":"Get Other Accounts of one Account","description":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
\nAuthentication is Optional
\nAuthentication is required if the view VIEW_ID is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","description_markdown":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\nAuthentication is required if the view VIEW_ID is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_accounts**](/glossary#other_accounts): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"other_accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}}]},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Counterparty","Account","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"other_accounts":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyCorporateLocation"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Delete Counterparty Corporate Location","description":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","Corporate Location cannot be deleted","Delete not completed","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv1.4.0-getCrmEvents","implemented_by":{"version":"OBPv1.4.0","function":"getCrmEvents"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/crm-events","summary":"Get CRM Events","description":"Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nactual_date: 2020-01-27
\nbank_id: gh.29.uk
\n\n\n\n\ncustomer_number: 5987953
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nscheduled_date: 2020-01-27
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**actual_date**](/glossary#actual_date): 2020-01-27\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**channel**](/glossary#channel): \n\n\n\n[**crm_events**](/glossary#crm_events): \n\n\n\n[**customer_name**](/glossary#customer_name): \n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**result**](/glossary#result): \n\n\n\n[**scheduled_date**](/glossary#scheduled_date): 2020-01-27\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"crm_events":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","bank_id":"gh.29.uk","customer_name":"String","customer_number":"5987953","category":"String","detail":"String","channel":"String","scheduled_date":"1100-01-01T00:00:00Z","actual_date":"1100-01-01T00:00:00Z","result":"String"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","No CRM Events available.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"crm_events":{"type":"array","items":{"type":"object","properties":{"scheduled_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"},"result":{"type":"string"},"customer_name":{"type":"string"},"category":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"detail":{"type":"string"},"channel":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/crm-events","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"updateWhereTagForViewOnTransaction"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Update a Transaction where Tag","description":"Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission:","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv2.0.0-deleteEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"deleteEntitlement"},"request_verb":"DELETE","request_url":"/obp/v2.0.0/users/USER_ID/entitlement/ENTITLEMENT_ID","summary":"Delete Entitlement","description":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
Authentication is Mandatory
\nURL Parameters:
\n\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ENTITLEMENT_ID](/glossary#entitlement_id): \n\n\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Role","User","Entitlement"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users/USER_ID/entitlement/ENTITLEMENT_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-createUserCustomerLinks","implemented_by":{"version":"OBPv2.0.0","function":"createUserCustomerLinks"},"request_verb":"POST","request_url":"/obp/v2.0.0/banks/BANK_ID/user_customer_links","summary":"Create User Customer Link","description":"Link a User to a Customer
\nAuthentication is Mandatory
\nCanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: true
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Link a User to a Customer\n\nAuthentication is Mandatory\n\nCanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_inserted**](/glossary#date_inserted): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**user_customer_link_id**](/glossary#user_customer_link_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"success_response_body":{"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","date_inserted":"1100-01-01T00:00:00Z","is_active":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID","OBP-30025: Could not create user_customer_links ","OBP-50000: Unknown Error."],"tags":["Customer","User","Old-Style"],"typed_request_body":{"type":"object","properties":{"customer_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"date_inserted":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateUserCustomerLink","requires_bank_id":true},{"role":"CanCreateUserCustomerLinkAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/user_customer_links","connector_methods":[]},{"operation_id":"OBPv2.1.0-updateBranch","implemented_by":{"version":"OBPv2.1.0","function":"updateBranch"},"request_verb":"PUT","request_url":"/obp/v2.1.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Update Branch","description":"Update an existing branch for a bank account (Authenticated access).
\nAuthentication is Mandatory
URL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n\n\ncity:
\ncountry: Germany
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nscheme: scheme value
\n\n","description_markdown":"Update an existing branch for a bank account (Authenticated access).\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[BRANCH_ID](/glossary#): DERBY6\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"bank_id":"gh.29.fi","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"hours":"5"},"drive_up":{"hours":"5"}},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"branch_routing":{"scheme":"BranchNumber","address":"678"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Branch","Old-Style"],"typed_request_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"roles":[{"role":"CanUpdateBranch","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addOtherAccountPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"addOtherAccountPrivateAlias"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Create Other Account Private Alias","description":"Creates a private alias for the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a private alias for the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a private alias","Alias cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"getKycMedia"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_media","summary":"Get KYC Media for a customer","description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
\nAuthentication is Mandatory
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**medias**](/glossary#medias): \n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"medias":[{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycMedia","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/customers/CUSTOMER_ID/kyc_media","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycDocuments","implemented_by":{"version":"OBPv2.0.0","function":"getKycDocuments"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_documents","summary":"Get Customer KYC Documents","description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
\nGet a list of documents that affirm the identity of the customer
\nPassport, driving licence etc.
\nAuthentication is Optional
Authentication is Mandatory
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID\nGet a list of documents that affirm the identity of the customer\nPassport, driving licence etc.\nAuthentication is Optional\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**documents**](/glossary#documents): \n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"documents":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1100-01-01T00:00:00Z","issue_place":"PlaceholderString","expiry_date":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycDocuments","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/customers/CUSTOMER_ID/kyc_documents","connector_methods":[]},{"operation_id":"OBPv1.2.1-addImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addImageForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Add a Transaction Image","description":"Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nThe image is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nlabel: My Account
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Posts an image about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nThe image is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"label":"String","URL":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-10017: Incorrect URL Format. ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":[]},{"operation_id":"OBPv1.4.0-addCustomerMessage","implemented_by":{"version":"OBPv1.4.0","function":"addCustomerMessage"},"request_verb":"POST","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","summary":"Create Customer Message","description":"Create a message for the customer specified by CUSTOMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_department: Open Bank
\nfrom_person: Tom
\nmessage: 123456
\nJSON response body fields:
\n\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"message":"String","from_department":"String","from_person":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"from_person":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","connector_methods":[]},{"operation_id":"OBPv2.1.0-getProducts","implemented_by":{"version":"OBPv2.1.0","function":"getProducts"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/products","summary":"Get Bank Products","description":"Returns information about the financial products offered by a bank specified by BANK_ID including:
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Returns information about the financial products offered by a bank specified by BANK_ID including:\n\n* Name\n* Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"products":[{"bank_id":"bankid123","code":"prod1","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/products","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteWhereTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Delete a Transaction Tag","description":"Deletes the where tag of the transaction TRANSACTION_ID made on view.
\nAuthentication is Mandatory
\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the where tag of the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20001: User not logged in. Authentication is required!","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","there is no tag to delete","Delete not completed","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nconnector_methods: connector_methods
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\n\nresource_docs: resource_docs
\nrole:
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"error_response_bodies":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}},"description_markdown":{"type":"string"},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"roles":[{"role":"CanReadResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/resource-docs/API_VERSION/obp","connector_methods":[]},{"operation_id":"OBPv2.0.0-getSocialMediaHandles","implemented_by":{"version":"OBPv2.0.0","function":"getSocialMediaHandles"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Get Customer Social Media Handles","description":"Get social media handles for a customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncustomer_number: 5987953
\n\n\n\ntype:
\n","description_markdown":"Get social media handles for a customer specified by CUSTOMER_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**checks**](/glossary#checks): \n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_activated**](/glossary#date_activated): \n\n\n\n[**date_added**](/glossary#date_added): \n\n\n\n[**handle**](/glossary#handle): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"checks":[{"customer_number":"5987953","type":"PlaceholderString","handle":"PlaceholderString","date_added":"1100-01-01T00:00:00Z","date_activated":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"date_activated":{"type":"string","format":"date-time"},"type":{"type":"string"},"customer_number":{"type":"string"},"handle":{"type":"string"}}}}}},"roles":[{"role":"CanGetSocialMediaHandles","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","connector_methods":[]},{"operation_id":"OBPv2.0.0-getCoreAccountById","implemented_by":{"version":"OBPv2.0.0","function":"getCoreAccountById"},"request_verb":"GET","request_url":"/obp/v2.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/account","summary":"Get Account by Id (Core)","description":"Information returned about the account specified by ACCOUNT_ID:
\nThis call returns the owner view and requires access to that view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\n\nprovider: ETHEREUM
\nscheme: scheme value
\n\ntype:
\n","description_markdown":"Information returned about the account specified by ACCOUNT_ID:\n\n* Number\n* Owners\n* Type\n* Balance\n* IBAN\n\nThis call returns the owner view and requires access to that view.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","number":"123","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"type":"OBP","balance":{"currency":"EUR","amount":"0"},"IBAN":"GR1301720530005053000582373","swift_bic":"UKTF3049auf","bank_id":"gh.29.uk","account_routing":{"scheme":"AccountNumber","address":"4930396"}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"swift_bic":{"type":"string"},"label":{"type":"string"},"id":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"IBAN":{"type":"string"},"type":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/account","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyPublicAlias"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Add public alias to other bank account","description":"Creates the public alias for the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication 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
\nthe 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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates the public alias for the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\nNote: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if\nthe public alias was deleted.\n\nThe VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","the view does not allow metadata access","the view does not allow adding a public alias","Alias cannot be added","public alias added"],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv2.1.0-getAtm","implemented_by":{"version":"OBPv2.1.0","function":"getAtm"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/atms/ATM_ID","summary":"Get Bank ATM","description":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
\nAuthentication is Optional
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ncity:
\ncountry: Germany
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:\n\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30009: ATM not found. Please specify a valid value for ATM_ID.","OBP-50000: Unknown Error."],"tags":["ATM","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/atms/ATM_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyCorporateLocation"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Update Counterparty Corporate Location","description":"Update the geolocation of the counterparty's registered address
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the geolocation of the counterparty's registered address\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"corporate_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating a corporate location","Coordinates not possible","Corporate Location cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycChecks","implemented_by":{"version":"OBPv2.0.0","function":"getKycChecks"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_checks","summary":"Get Customer KYC Checks","description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: true
\n\n\n","description_markdown":"Get KYC checks for the Customer specified by CUSTOMER_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**checks**](/glossary#checks): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): true\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"checks":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1100-01-01T00:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"string"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycChecks","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/customers/CUSTOMER_ID/kyc_checks","connector_methods":[]},{"operation_id":"OBPv2.2.0-getMessageDocs","implemented_by":{"version":"OBPv2.2.0","function":"getMessageDocs"},"request_verb":"GET","request_url":"/obp/v2.2.0/message-docs/CONNECTOR","summary":"Get Message Docs","description":"These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
\nIntegrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
\nCONNECTOR
: kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nprocess: obp.getBank
\n\n\n\n\n\n\nrequiredFieldInfo: false
\n","description_markdown":"These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.\n Integrators can use these messages to build Adapters that provide core banking services to OBP.\n\n Note: API Explorer provides a Message Docs page where these messages are displayed.\n \n `CONNECTOR`: kafka_vSept2018, stored_procedure_vDec2019 ...\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[CONNECTOR](/glossary#Connector): CONNECTOR\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**adapter_implementation**](/glossary#adapter_implementation): \n\n\n\n[**dependent_endpoints**](/glossary#dependent_endpoints): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**example_inbound_message**](/glossary#example_inbound_message): {}\n\n\n\n[**example_outbound_message**](/glossary#example_outbound_message): {}\n\n\n\n[**group**](/glossary#group): \n\n\n\n[**message_docs**](/glossary#message_docs): \n\n\n\n[**message_format**](/glossary#message_format): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n\n[**suggested_order**](/glossary#suggested_order): \n\n\n\n[**version**](/glossary#version): \n\n\n\n[inboundAvroSchema](/glossary#inboundavroschema): \n\n\n\n[inbound_topic](/glossary#inbound_topic): \n\n\n\n[outboundAvroSchema](/glossary#outboundavroschema): \n\n\n\n[outbound_topic](/glossary#outbound_topic): \n\n\n\n[requiredFieldInfo](/glossary#requiredfieldinfo): false\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"message_docs":[{"process":"getAccounts","message_format":"KafkaV2017","outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts","inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts","description":"get Banks","example_outbound_message":{"jsonString":"{}"},"example_inbound_message":{"jsonString":"{}"},"outboundAvroSchema":{"jsonString":"{}"},"inboundAvroSchema":{"jsonString":"{}"},"adapter_implementation":{"group":"CORE","suggested_order":3},"dependent_endpoints":[{"name":"getAccounts","version":"OBPv3.0.0"},{"name":"getBalances","version":"OBPv2.0.0"}],"requiredFieldInfo":{"data.bankId":["v2.2.0","v3.1.0"]}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"message_docs":{"type":"array","items":{"type":"object","properties":{"dependent_endpoints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}},"inbound_topic":{"type":"string"},"message_format":{"type":"string"},"outbound_topic":{"type":"string"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"adapter_implementation":{"type":"object","properties":{"group":{"type":"string"},"suggested_order":{"type":"integer"}}},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"type":"string"}}}},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}},"process":{"type":"string"},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"description":{"type":"string"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/message-docs/CONNECTOR","connector_methods":[]},{"operation_id":"OBPv2.0.0-getAllEntitlements","implemented_by":{"version":"OBPv2.0.0","function":"getAllEntitlements"},"request_verb":"GET","request_url":"/obp/v2.0.0/entitlements","summary":"Get all Entitlements","description":"Login is required.
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Login is required.\n\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Role","Entitlement"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/entitlements","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyMoreInfo"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Update Counterparty More Info","description":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"more_info":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating more info","More Info cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"more_info":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPublicAlias"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Delete Counterparty Public Alias","description":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting the public alias","Alias cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv2.0.0-addSocialMediaHandle","implemented_by":{"version":"OBPv2.0.0","function":"addSocialMediaHandle"},"request_verb":"POST","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Create Customer Social Media Handle","description":"Create a customer social media handle for the customer specified by CUSTOMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\ncustomer_number: 5987953
\n\n\n\ntype:
\nJSON response body fields:
\n\n","description_markdown":"Create a customer social media handle for the customer specified by CUSTOMER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_activated**](/glossary#date_activated): \n\n\n\n[**date_added**](/glossary#date_added): \n\n\n\n[**handle**](/glossary#handle): \n\n\n\n[**type**](/glossary#type): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"customer_number":"5987953","type":"PlaceholderString","handle":"PlaceholderString","date_added":"1100-01-01T00:00:00Z","date_activated":"1100-01-01T00:00:00Z"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20006: User is missing one or more roles: ","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"date_activated":{"type":"string","format":"date-time"},"type":{"type":"string"},"customer_number":{"type":"string"},"handle":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanAddSocialMediaHandle","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","connector_methods":[]},{"operation_id":"OBPv1.2.1-bankById","implemented_by":{"version":"OBPv1.2.1","function":"bankById"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID","summary":"Get Bank","description":"Get the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nscheme: scheme value
\n\nwebsite: www.openbankproject.com
\n","description_markdown":"Get the bank specified by BANK_ID\nReturns information about a single bank specified by BANK_ID including:\n\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routing":{"scheme":"scheme value","address":""}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID."],"tags":["Bank","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-createViewForBankAccount","implemented_by":{"version":"OBPv2.2.0","function":"createViewForBankAccount"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","summary":"Create View","description":"Authentication is Mandatory and the user needs to have access to the owner view.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
You should use a leading _ (underscore) for the view name because other view names may become reserved by OBP internally
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nis_public: true
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nJSON response body fields:
\n\n\n\ncan_add_counterparty: true
\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n","description_markdown":"#Create a view on bank account\n\n Authentication is Mandatory and the user needs to have access to the owner view.\n The 'alias' field in the JSON can take one of three values:\n\n * _public_: to use the public alias if there is one specified for the other account.\n * _private_: to use the public alias if there is one specified for the other account.\n\n * _''(empty string)_: to use no alias; the view shows the real name of the other account.\n\n The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to `true` and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.\n\n The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to `true` on the view creation, the rest will be set to `false`.\n\n You should use a leading _ (underscore) for the view name because other view names may become reserved by OBP internally\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**allowed_actions**](/glossary#allowed_actions): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**which_alias_to_use**](/glossary#which_alias_to_use): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): true\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n","example_request_body":{"name":"_test","description":"This view is for family","is_public":true,"which_alias_to_use":"family","hide_metadata_if_alias_used":false,"allowed_actions":["can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_label","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_narrative","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_edit_narrative","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_create_counterparty","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","is_public":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Account","View-Custom","Old-Style"],"typed_request_body":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycStatus","implemented_by":{"version":"OBPv2.0.0","function":"addKycStatus"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","summary":"Add KYC Status","description":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: true
\n","description_markdown":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): true\n\n\n","example_request_body":{"customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"},"success_response_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-00004: Server error: could not add message","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}},"roles":[{"role":"CanAddKycStatus","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateAccountLabel","implemented_by":{"version":"OBPv1.2.1","function":"updateAccountLabel"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account Label","description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nJSON response body fields:
\n\n","description_markdown":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"id":"123123","label":"label","bank_id":"gh.29.uk"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","user does not have access to owner view on account"],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"id":{"type":"string"},"bank_id":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-getCurrentFxRate","implemented_by":{"version":"OBPv2.2.0","function":"getCurrentFxRate"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE","summary":"Get Current FxRate","description":"Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
\nOBP may try different sources of FX rate information depending on the Connector in operation.
\nFor example we want to convert EUR => USD:
\nOBP will:
\n1st try - Connector (database, core banking system or external FX service)
\n2nd try part 1 - fallbackexchangerates/eur.json
\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
\n3rd try - Hardcoded map of FX rates.
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nTO_CURRENCY_CODE: EUR
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\n\n\nto_currency_code: EUR
\n","description_markdown":"Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE\n\nOBP may try different sources of FX rate information depending on the Connector in operation.\n\nFor example we want to convert EUR => USD:\n\nOBP will:\n1st try - Connector (database, core banking system or external FX service)\n2nd try part 1 - fallbackexchangerates/eur.json\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)\n3rd try - Hardcoded map of FX rates.\n\n![FX Flow](https://user-images.githubusercontent.com/485218/60005085-1eded600-966e-11e9-96fb-798b102d9ad0.png)\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[FROM_CURRENCY_CODE](/glossary#from_currency_code): \n\n\n\n[TO_CURRENCY_CODE](/glossary#to_currency_code): EUR\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**conversion_value**](/glossary#conversion_value): 100\n\n\n\n[**effective_date**](/glossary#effective_date): 2020-01-27\n\n\n\n[**from_currency_code**](/glossary#from_currency_code): \n\n\n\n[**inverse_conversion_value**](/glossary#inverse_conversion_value): 50\n\n\n\n[**to_currency_code**](/glossary#to_currency_code): EUR\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"bank_id":"gh.29.uk","from_currency_code":"EUR","to_currency_code":"GBP","conversion_value":1.001,"inverse_conversion_value":0.998,"effective_date":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code. ","OBP-20001: User not logged in. Authentication is required!","OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE. ","OBP-50000: Unknown Error."],"tags":["FX"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"to_currency_code":{"type":"string"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"conversion_value":{"type":"number"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE","connector_methods":[]},{"operation_id":"OBPv2.1.0-addCardsForBank","implemented_by":{"version":"OBPv2.1.0","function":"addCardsForBank"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/cards","summary":"Create Card","description":"Create Card at bank specified by BANK_ID .
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\ncollected: 2020-01-27
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nname_on_card: SusanSmith
\n\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ncancelled: true
\ncollected: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nenabled: true
\nexpires_date: 2021-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Create Card at bank specified by BANK_ID .\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_card_number**](/glossary#): 364435172576215\n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_card_number**](/glossary#): 364435172576215\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**cancelled**](/glossary#cancelled): true\n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"bank_card_number":"364435172576215","name_on_card":"name_on_card","issue_number":"1","serial_number":"1324234","valid_from_date":"1100-01-01T00:00:00Z","expires_date":"1100-01-01T00:00:00Z","enabled":true,"technology":"technology","networks":["network1","network2"],"allows":["credit","debit"],"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","replacement":{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"FORGOT"},{"requested_date":"2024-02-27T14:01:45Z","reason_requested":"GOOD_SECURITY_PRACTICE"}],"collected":"1100-01-01T00:00:00Z","posted":"1100-01-01T00:00:00Z"},"success_response_body":{"bank_id":"gh.29.uk","bank_card_number":"364435172576215","name_on_card":"String","issue_number":"1","serial_number":"1324234","valid_from_date":"1100-01-01T00:00:00Z","expires_date":"1100-01-01T00:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"String","networks":["String"],"allows":["String"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"FORGOT"}],"collected":"1100-01-01T00:00:00Z","posted":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10015: Allowed values are:","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"expires_date":{"type":"string","format":"date-time"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"posted":{"type":"string","format":"date-time"},"bank_card_number":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string"},"name_on_card":{"type":"string"},"serial_number":{"type":"string"},"account_id":{"type":"string"},"technology":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"technology":{"type":"string"},"name_on_card":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"bank_card_number":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"valid_from_date":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/cards","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Delete url of other bank account","description":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting a url","URL cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv2.2.0-createBank","implemented_by":{"version":"OBPv2.2.0","function":"createBank"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks","summary":"Create Bank","description":"Create a new bank (Authenticated access).
\nAuthentication is Mandatory
JSON request body fields:
\n\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo_url: logo_url
\n\nscheme: scheme value
\n\n\nwebsite_url: website_url
\nJSON response body fields:
\n\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo_url: logo_url
\n\nscheme: scheme value
\n\n\nwebsite_url: website_url
\n","description_markdown":"Create a new bank (Authenticated access).\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo_url**](/glossary#): logo_url\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**website_url**](/glossary#): website_url\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo_url**](/glossary#): logo_url\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**website_url**](/glossary#): website_url\n\n\n","example_request_body":{"id":"gh.29.uk.x","full_name":"uk","short_name":"uk","logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png","website_url":"https://www.example.com","swift_bic":"IIIGGB22","national_identifier":"UK97ZZZ1234567890","bank_routing":{"scheme":"BIC","address":"OKOYFIHH"}},"success_response_body":{"id":"gh.29.uk.x","full_name":"uk","short_name":"uk","logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png","website_url":"https://www.example.com","swift_bic":"IIIGGB22","national_identifier":"UK97ZZZ1234567890","bank_routing":{"scheme":"BIC","address":"OKOYFIHH"}},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank","Old-Style"],"typed_request_body":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"full_name":{"type":"string"},"national_identifier":{"type":"string"},"swift_bic":{"type":"string"},"website_url":{"type":"string"},"short_name":{"type":"string"},"id":{"type":"string"},"logo_url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"full_name":{"type":"string"},"national_identifier":{"type":"string"},"swift_bic":{"type":"string"},"website_url":{"type":"string"},"short_name":{"type":"string"},"id":{"type":"string"},"logo_url":{"type":"string"}}},"roles":[{"role":"CanCreateBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestCounterparty","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestCounterparty"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","summary":"Create Transaction Request (COUNTERPARTY)","description":"Special instructions for COUNTERPARTY:
\nWhen using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.
\nThe routing details of the counterparty will be forwarded for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for COUNTERPARTY:\n\nWhen using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.\nThe routing details of the counterparty will be forwarded for the transfer.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY](/glossary#counterparty): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A description for the transaction to the counterparty","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-addPermissionForUserForBankAccountForOneView","implemented_by":{"version":"OBPv1.2.1","function":"addPermissionForUserForBankAccountForOneView"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","summary":"Grant User access to View","description":"Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nGranting access to a public view will return an error message, as the user already has access.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n","description_markdown":"Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.\n\nAll url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for PROVIDER and PROVIDER_ID.\n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\nGranting access to a public view will return an error message, as the user already has access.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","OBP-20047: The current user does not have access to a view which lists the target account in cangrantaccesstoviews_ permissions","could not save the privilege","user does not have access to owner view on account"],"tags":["View-Custom","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addCommentForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Add a Transaction Comment","description":"Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
\n${authenticationRequiredMessage(false)}
\nAuthentication is required since the comment is linked with the user.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a comment about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\n${authenticationRequiredMessage(false)}\n\nAuthentication is required since the comment is linked with the user.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteCommentForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","summary":"Delete a Transaction Comment","description":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COMMENT_ID](/glossary#comment_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-getExplictCounterpartiesForAccount","implemented_by":{"version":"OBPv2.2.0","function":"getExplictCounterpartiesForAccount"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Get Counterparties (Explicit)","description":"Get the Counterparties (Explicit) for the account / view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: true
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address:
\n\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\n\nvalue: 5987953
\n","description_markdown":"Get the Counterparties (Explicit) for the account / view.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**counterparties**](/glossary#counterparties): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): true\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): \n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): \n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"counterparties":[{"name":"CounterpartyName","description":"My landlord","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"OBP","other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission:","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Counterparty","Payment Initiation Service (PIS)","Account","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"counterparties":{"type":"array","items":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_account_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_account_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv1.4.0-getAtms","implemented_by":{"version":"OBPv1.4.0","function":"getAtms"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/atms","summary":"Get Bank ATMS","description":"Returns information about ATMs for a single bank specified by BANK_ID including:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\natms:
\ncity:
\ncountry: Germany
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Returns information about ATMs for a single bank specified by BANK_ID including:\n\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"atms":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","No ATMs available. License may not be set.","OBP-50000: Unknown Error."],"tags":["Bank","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/atms","connector_methods":[]},{"operation_id":"OBPv2.0.0-publicAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/accounts/public","summary":"Get Public Accounts at all Banks","description":"Get public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
Authentication is Optional
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Get public accounts at all banks (Anonymous access).\nReturns accounts that contain at least one public view (a view where is_public is true)\nFor each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30066: Could not get accounts.","OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/accounts/public","connector_methods":[]},{"operation_id":"OBPv2.0.0-getPrivateAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"getPrivateAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/accounts","summary":"Get all Accounts at all Banks","description":"Get all accounts at all banks the User has access to.
\nReturns the list of accounts at that the user has access to at all banks.
\nFor each account the API returns the account ID and the available views.
Authentication is Mandatory
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Get all accounts at all banks the User has access to.\nReturns the list of accounts at that the user has access to at all banks.\nFor each account the API returns the account ID and the available views.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","PrivateData","PublicData","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/accounts","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyMoreInfo"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Add Counterparty More Info","description":"Add a description of the counter party from the perpestive of the account e.g. My dentist
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nmore_info: More information about this fee
\nJSON response body fields:
\n\n","description_markdown":"Add a description of the counter party from the perpestive of the account e.g. My dentist\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"more_info":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","the view ownerdoes not allow adding more info","More Info cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"more_info":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":[]},{"operation_id":"OBPv2.0.0-getUser","implemented_by":{"version":"OBPv2.0.0","function":"getUser"},"request_verb":"GET","request_url":"/obp/v2.0.0/users/USER_EMAIL","summary":"Get Users by Email Address","description":"Get users by email address
\nLogin is required.
\nCanGetAnyUser entitlement is required,
Authentication is Mandatory
\nURL Parameters:
\nUSER_EMAIL: USER_EMAIL
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\n","description_markdown":"Get users by email address\n\nLogin is required.\nCanGetAnyUser entitlement is required,\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[USER_EMAIL](/glossary#): USER_EMAIL\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-20007: User not found by email.","OBP-50000: Unknown Error."],"tags":["User","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users/USER_EMAIL","connector_methods":[]},{"operation_id":"OBPv2.1.0-getConsumer","implemented_by":{"version":"OBPv2.1.0","function":"getConsumer"},"request_verb":"GET","request_url":"/obp/v2.1.0/management/consumers/CONSUMER_ID","summary":"Get Consumer","description":"Get the Consumer specified by CONSUMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: true
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get the Consumer specified by CONSUMER_ID.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**app_type**](/glossary#app_type): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"consumer_id":1213,"app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.","OBP-50000: Unknown Error."],"tags":["Consumer","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}},"roles":[{"role":"CanGetConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/consumers/CONSUMER_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-getViewsForBankAccount","implemented_by":{"version":"OBPv2.2.0","function":"getViewsForBankAccount"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","summary":"Get Views for Account","description":"Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
\nData: When a view moderates a set of data, some fields my contain the value null
rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
\nAction: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
\nMetadata:
\nTransaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: true
\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n\n","description_markdown":"#Views\n\n\nViews in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.\n\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.\n\n**Data:** When a view moderates a set of data, some fields my contain the value `null` rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.\n\nThere is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.\n\n**Action:** When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.\n\n**Metadata:**\nTransaction metadata (like images, tags, comments, etc.) will appears *ONLY* on the view where they have been created e.g. comments posted to the public view only appear on the public view.\n\nThe other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).\n\n# All\n*Optional*\n\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.\n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): true\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"views":[{"id":"1234","short_name":"short_name","description":"description","is_public":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionType","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionType"},"request_verb":"PUT","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-types","summary":"Create Transaction Type at bank","description":"Create Transaction Types for the bank specified by BANK_ID:
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nvalue: 5987953
\n","description_markdown":"Create Transaction Types for the bank specified by BANK_ID:\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bankId**](/glossary#bankid): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**shortCode**](/glossary#shortcode): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}},"success_response_body":{"id":{"value":"123"},"bankId":{"value":"gh.uk.9j"},"shortCode":"80080","summary":"SANDBOX_TAN","description":"This is the sandbox mode, charging litter money.","charge":{"currency":"EUR","amount":"100"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"bankId":{"type":"object","properties":{"value":{"type":"string"}}},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"},"shortCode":{"type":"string"},"description":{"type":"string"},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"roles":[{"role":"CanCreateTransactionType","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv2.0.0-getEntitlements","implemented_by":{"version":"OBPv2.0.0","function":"getEntitlements"},"request_verb":"GET","request_url":"/obp/v2.0.0/users/USER_ID/entitlements","summary":"Get Entitlements for User","description":"Authentication is Mandatory
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetEntitlementsForAnyUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users/USER_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv2.2.0-createBranch","implemented_by":{"version":"OBPv2.2.0","function":"createBranch"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks/BANK_ID/branches","summary":"Create Branch","description":"Create Branch for the Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nbank_id: gh.29.uk
\n\ncity:
\ncountry: Germany
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nscheme: scheme value
\n\nJSON response body fields:
\n\nbank_id: gh.29.uk
\n\ncity:
\ncountry: Germany
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nscheme: scheme value
\n\n","description_markdown":"Create Branch for the Bank.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"id":"123","bank_id":"gh.29.uk","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"branch_routing":{"scheme":"BranchNumber","address":"678"}},"success_response_body":{"id":"123","bank_id":"gh.29.uk","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"branch_routing":{"scheme":"BranchNumber","address":"678"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Branch","Open-Data","Old-Style"],"typed_request_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"roles":[{"role":"CanCreateBranch","requires_bank_id":true},{"role":"CanCreateBranchAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/branches","connector_methods":[]},{"operation_id":"OBPv1.2.1-getBanks","implemented_by":{"version":"OBPv1.2.1","function":"getBanks"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks","summary":"Get Banks","description":"Get banks on this API instance
\nReturns a list of banks supported on this server:
Authentication is Optional
\nJSON response body fields:
\n\n\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nscheme: scheme value
\n\nwebsite: www.openbankproject.com
\n","description_markdown":"Get banks on this API instance\nReturns a list of banks supported on this server:\n\n* ID used as parameter in URLs\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routing":{"scheme":"scheme value","address":""}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Bank","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks","connector_methods":[]},{"operation_id":"OBPv2.1.0-createCustomer","implemented_by":{"version":"OBPv2.1.0","function":"createCustomer"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/customers","summary":"Create Customer","description":"Add a customer linked to the user specified by user_id
\nThe Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
\nDates need to be in the format 2013-01-21T23:08:00Z
Authentication is Mandatory
\nCanCreateCustomer and CanCreateUserCustomerLink OR CanCreateCustomerAtAnyBank and CanCreateUserCustomerLinkAtAnyBank
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: true
\nlast_ok_date: 2023-02-27T14:01:45.181Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: true
\nlast_ok_date: 2023-02-27T14:01:45.181Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Add a customer linked to the user specified by user_id\nThe Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.\nDates need to be in the format 2013-01-21T23:08:00Z\n\nAuthentication is Mandatory\n\nCanCreateCustomer and CanCreateUserCustomerLink OR CanCreateCustomerAtAnyBank and CanCreateUserCustomerLinkAtAnyBank\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**credit_limit**](/glossary#credit_limit): \n\n\n\n[**credit_rating**](/glossary#credit_rating): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): true\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2023-02-27T14:01:45.181Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): true\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2023-02-27T14:01:45.181Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":true,"last_ok_date":"2023-02-27T14:01:45Z"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":true,"last_ok_date":"2023-02-27T14:01:45Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID","OBP-30024: Could not create Consumer ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","Person","Old-Style"],"typed_request_body":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"last_ok_date":{"type":"string","format":"date-time"},"employment_status":{"type":"string"},"email":{"type":"string"},"relationship_status":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"user_id":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanCreateCustomer","requires_bank_id":true},{"role":"CanCreateUserCustomerLink","requires_bank_id":true},{"role":"CanCreateCustomerAtAnyBank","requires_bank_id":false},{"role":"CanCreateUserCustomerLinkAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTransactionsForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"getTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","summary":"Get Transactions for Account (Full)","description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\namount: 10.12
\nbank:
\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nkind:
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nnew_balance: 20
\n\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\n\ntags: Create-My-User
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns transactions list of the account specified by ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nAuthentication via OAuth is required if the view is not public.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2024-02-27T14:01:48.099Z. NOTE! The default value is now (2024-02-27T14:01:48.099Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transactions":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","this_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holders":[{"name":"OBP","is_alias":true}],"number":"123","kind":"AC","IBAN":"UK1234AD","swift_bic":"UK1234AD","bank":{"national_identifier":"OBP","name":"OBP"}},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"details":{"type":"AC","description":"this is for family","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}}]},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Transaction","Account","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"id":{"type":"string"},"this_account":{"type":"object","properties":{"swift_bic":{"type":"string"},"number":{"type":"string"},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"kind":{"type":"string"},"IBAN":{"type":"string"}}},"other_account":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestSepa","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestSepa"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","summary":"Create Transaction Request (SEPA)","description":"Special instructions for SEPA:
\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSEPA:
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\niban: DE91 1000 0000 0123 4567 89
\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for SEPA:\n\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SEPA](/glossary#sepa): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"to":{"iban":"123"},"description":"This is a SEPA Transaction Request","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"future_date":{"type":"string"},"to":{"type":"object","properties":{"iban":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-getWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getWhereTagForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Get a Transaction where Tag","description":"Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
\nIt represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\nlongitude: -77.0364
\nprovider: ETHEREUM
\nuser:
\n\n","description_markdown":"Returns the \"where\" Geo tag added to the transaction TRANSACTION_ID made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\nIt represents the location where the transaction has been initiated.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**where**](/glossary#where): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"where":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv1.2.1-removePermissionForUserForBankAccountForOneView","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForOneView"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","summary":"Revoke access to one View","description":"Revokes access to a View on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Revokes access to a View on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","could not save the privilege","user does not have access to owner view on account","OBP-50000: Unknown Error."],"tags":["View-Custom","Account","User","Entitlement","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv2.1.0-answerTransactionRequestChallenge","implemented_by":{"version":"OBPv2.1.0","function":"answerTransactionRequestChallenge"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","summary":"Answer Transaction Request Challenge","description":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
\n1)TRANSACTION_REQUEST_TYPE
: is the same as createTransactionRequest request URL .
2)TRANSACTION_REQUEST_ID
: is the id
field in createTransactionRequest response body.
3) id
: is challenge.id
field in createTransactionRequest response body.
4) answer
: must be 123
. if it is in sandbox mode. If it kafka mode, the answer can be got by phone message or other security ways.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nTRANSACTION_REQUEST_TYPE: SEPA
\nVIEW_ID: owner
\nJSON request body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_id: gh.29.uk
\n\n\n\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nstart_date: 2020-01-27
\n\n\nto:
\n\ntype:
\nvalue: 5987953
\n","description_markdown":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.\n\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.\n\n1)`TRANSACTION_REQUEST_TYPE` : is the same as createTransactionRequest request URL . \n\n2)`TRANSACTION_REQUEST_ID` : is the `id` field in createTransactionRequest response body.\n\n3) `id` : is `challenge.id` field in createTransactionRequest response body. \n\n4) `answer` : must be `123`. if it is in sandbox mode. If it kafka mode, the answer can be got by phone message or other security ways.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n[TRANSACTION_REQUEST_TYPE](/glossary#): SEPA\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"id":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there.","answer":"123"},"success_response_body":{"id":"82f92531-9c63-4246-abfc-96c20ec46188","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to":{"bank_id":"String","account_id":"String"},"value":{"currency":"EUR","amount":"100"},"description":"String"},"transaction_ids":"666666-9c63-4246-abfc-96c20ec46188","status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40011: Transaction Request Status is not INITIATED.","OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.","OBP-40010: Invalid Challenge Id. Please specify a valid value for CHALLENGE_ID.","OBP-40014: Sorry, you've used up your allowed attempts. ","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"description":{"type":"string"}}},"id":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_ids":{"type":"string"},"start_date":{"type":"string","format":"date-time"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTransactionByIdForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"getTransactionByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","summary":"Get Transaction by Id","description":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\namount: 10.12
\nbank:
\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nkind:
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nnew_balance: 20
\n\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\n\ntags: Create-My-User
\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","this_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holders":[{"name":"OBP","is_alias":true}],"number":"123","kind":"AC","IBAN":"UK1234AD","swift_bic":"UK1234AD","bank":{"national_identifier":"OBP","name":"OBP"}},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"details":{"type":"AC","description":"this is for family","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Transaction","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"id":{"type":"string"},"this_account":{"type":"object","properties":{"swift_bic":{"type":"string"},"number":{"type":"string"},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"kind":{"type":"string"},"IBAN":{"type":"string"}}},"other_account":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPhysicalLocation"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Update Counterparty Physical Location","description":"Update geocoordinates of the counterparty's main location
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update geocoordinates of the counterparty's main location\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"physical_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating a physical location","Coordinates not possible","Physical Location cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":[]},{"operation_id":"OBPv2.0.0-publicAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/public","summary":"Get Public Accounts at Bank","description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/public","connector_methods":[]},{"operation_id":"OBPv2.1.0-getTransactionRequests","implemented_by":{"version":"OBPv2.1.0","function":"getTransactionRequests"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","summary":"Get Transaction Requests","description":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\ntransaction_requests_with_charges:
\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.\n\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.\n\nVersion 2.0.0 now returns charge information.\n\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:\n\n* Transaction Request Id\n* Type\n* Status (INITIATED, COMPLETED)\n* Challenge (in order to confirm the request)\n* From Bank / Account\n* Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)\n* Related Transactions\n\nPSD2 Context: PSD2 requires transparency of charges to the customer.\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.\nThe customer can proceed with the Transaction by answering the security challenge.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transaction_requests_with_charges**](/glossary#transaction_requests_with_charges): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_requests_with_charges":[{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_requests_with_charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteViewForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"deleteViewForBankAccount"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","summary":"Delete Custom View","description":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","user does not have owner access"],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyOpenCorporatesUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Add Open Corporates URL to Counterparty","description":"Add open corporates url to other bank account
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Add open corporates url to other bank account\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"open_corporates_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding an open corporate url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv2.2.0-getExplictCounterpartyById","implemented_by":{"version":"OBPv2.2.0","function":"getExplictCounterpartyById"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Get Counterparty by Counterparty Id (Explicit)","description":"Information returned about the Counterparty specified by COUNTERPARTY_ID:
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address:
\n\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"Information returned about the Counterparty specified by COUNTERPARTY_ID:\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): true\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): \n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): \n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"name":"CounterpartyName","description":"My landlord","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"OBP","other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Counterparty","Payment Initiation Service (PIS)","Counterparty-Metadata","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_account_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_account_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Add a Transaction Tag","description":"Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a tag about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyImageUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Add image url to other bank account","description":"Add a url that points to the logo of the counterparty
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Add a url that points to the logo of the counterparty\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"image_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding an image url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"image_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv2.2.0-config","implemented_by":{"version":"OBPv2.2.0","function":"config"},"request_verb":"GET","request_url":"/obp/v2.2.0/config","summary":"Get API Configuration","description":"Returns information about:
\nAuthentication is Mandatory
\nJSON response body fields:
\nakka:
\n\n\n\n\n\n\n\n\nrequire_scopes_for_listed_roles: true
\n\n\nvalue: 5987953
\n\n\n","description_markdown":"Returns information about:\n\n* API Config\n* Akka ports\n* Elastic search ports\n* Cached function \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**akka**](/glossary#akka): \n\n\n\n[**cache**](/glossary#cache): \n\n\n\n[**elastic_search**](/glossary#elastic_search): \n\n\n\n[**function_name**](/glossary#function_name): \n\n\n\n[**log_level**](/glossary#log_level): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n\n[**ports**](/glossary#ports): \n\n\n\n[**property**](/glossary#property): \n\n\n\n[**require_scopes_for_all_roles**](/glossary#require_scopes_for_all_roles): \n\n\n\n[**require_scopes_for_listed_roles**](/glossary#require_scopes_for_listed_roles): true\n\n\n\n[**scopes**](/glossary#scopes): \n\n\n\n[**ttl_in_seconds**](/glossary#ttl_in_seconds): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**warehouse**](/glossary#warehouse): \n\n\n\n[remote_data_secret_matched](/glossary#remote_data_secret_matched): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"akka":{"ports":[{"property":"default","value":"8080"}],"log_level":"Debug","remote_data_secret_matched":true},"elastic_search":{"metrics":[{"property":"String","value":"Mapper"}],"warehouse":[{"property":"String","value":"ElasticSearch"}]},"cache":[{"function_name":"getBanks","ttl_in_seconds":5}],"scopes":{"require_scopes_for_all_roles":true,"require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"elastic_search":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string"},"value":{"type":"string"}}}},"warehouse":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}}}},"scopes":{"type":"object","properties":{"require_scopes_for_all_roles":{"type":"boolean"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"akka":{"type":"object","properties":{"ports":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}},"remote_data_secret_matched":{"type":"boolean"},"log_level":{"type":"string"}}},"cache":{"type":"array","items":{"type":"object","properties":{"ttl_in_seconds":{"type":"integer"},"function_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetConfig","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/config","connector_methods":[]},{"operation_id":"OBPv1.3.0-getCardsForBank","implemented_by":{"version":"OBPv1.3.0","function":"getCardsForBank"},"request_verb":"GET","request_url":"/obp/v1.3.0/banks/BANK_ID/cards","summary":"Get cards for the specified bank","description":"Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ncancelled: true
\n\ncollected: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nenabled: true
\nexpires_date: 2021-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_card_number**](/glossary#): 364435172576215\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**cancelled**](/glossary#cancelled): true\n\n\n\n[**cards**](/glossary#cards): \n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"cards":[{"bank_id":"gh.29.uk","bank_card_number":"364435172576215","name_on_card":"String","issue_number":"1","serial_number":"1324234","valid_from_date":"1100-01-01T00:00:00Z","expires_date":"1100-01-01T00:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"String","networks":["String"],"allows":["String"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"FORGOT"}],"collected":"1100-01-01T00:00:00Z","posted":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Card","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"technology":{"type":"string"},"name_on_card":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"bank_card_number":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"valid_from_date":{"type":"string","format":"date-time"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/cards","connector_methods":[]},{"operation_id":"OBPv2.1.0-getRoles","implemented_by":{"version":"OBPv2.1.0","function":"getRoles"},"request_verb":"GET","request_url":"/obp/v2.1.0/roles","summary":"Get Roles","description":"Returns all available roles
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nrole:
\nroles: CanCreateMyUser
\n","description_markdown":"Returns all available roles\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**requires_bank_id**](/glossary#requires_bank_id): \n\n\n\n[**role**](/glossary#role): \n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"roles":[{"role":"CanCreateBranch","requires_bank_id":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Role"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/roles","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsSwagger","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsSwagger"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/swagger","summary":"Get Swagger documentation","description":"Returns documentation about the RESTful resources on this server in Swagger format.
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
\n(All endpoints are given one or more tags which for used in grouping)
\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
\n(Each endpoint is implemented in the OBP Scala code by a 'function')
\nSee the Resource Doc endpoint for more information.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nFollowing are more examples:
\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Returns documentation about the RESTful resources on this server in Swagger format.\n\nAPI_VERSION is the version you want documentation about e.g. v3.0.0\n\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank\n\n(All endpoints are given one or more tags which for used in grouping)\n\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById\n\n(Each endpoint is implemented in the OBP Scala code by a 'function')\n\nSee the Resource Doc endpoint for more information.\n\n Note: Resource Docs are cached, TTL is 3600 seconds\n \nFollowing are more examples:\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\nhttps://ifcsandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById\n\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_VERSION](/glossary#api_version): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv2.2.0-getConnectorMetrics","implemented_by":{"version":"OBPv2.2.0","function":"getConnectorMetrics"},"request_verb":"GET","request_url":"/obp/v2.2.0/management/connector/metrics","summary":"Get Connector Metrics","description":"Get the all metrics
\nrequire CanGetConnectorMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 1000) eg:limit=2000
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300
\nOther filters:
\n5 connector_name (if null ignore)
\n6 function_name (if null ignore)
\n7 correlation_id (if null ignore)
\nAuthentication is Mandatory
\nJSON response body fields:
\n\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nduration: 5.123
\n\n\n","description_markdown":"Get the all metrics\n\nrequire CanGetConnectorMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/connector/metrics\n\nShould be able to filter on the following metrics fields\n\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2\n\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 limit (for pagination: defaults to 1000) eg:limit=2000\n\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300\n\nOther filters:\n\n5 connector_name (if null ignore)\n\n6 function_name (if null ignore)\n\n7 correlation_id (if null ignore)\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**connector_name**](/glossary#connector_name): \n\n\n\n[**correlation_id**](/glossary#): 1flssoftxq0cr1nssr68u0mioj\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**duration**](/glossary#duration): 5.123\n\n\n\n[**function_name**](/glossary#function_name): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"metrics":[{"connector_name":"mapper","function_name":"getBanks","correlation_id":"12345","date":"1100-01-01T00:00:00Z","duration":1000}]},"error_response_bodies":["OBP-10005: Invalid Date Format. Could not convert value to a Date.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"connector_name":{"type":"string"},"duration":{"type":"integer"},"date":{"type":"string","format":"date-time"},"correlation_id":{"type":"string"},"function_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetConnectorMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/connector/metrics","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyCorporateLocation"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Add Corporate Location to Counterparty","description":"Add the geolocation of the counterparty's registered address
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nJSON response body fields:
\n\n","description_markdown":"Add the geolocation of the counterparty's registered address\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"corporate_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow adding a corporate location","Coordinates not possible","Corporate Location cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Add url to other bank account","description":"A url which represents the counterparty (home page url etc.)
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsObpV400","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObpV400"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nconnector_methods: connector_methods
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\n\nresource_docs: resource_docs
\nresponse_date: response_date
\nrole:
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}],"meta":{"response_date":"2024-02-27T14:01:50Z","count":1}},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"meta":{"type":"object","properties":{"response_date":{"type":"string","format":"date-time"},"count":{"type":"integer"}}},"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"error_response_bodies":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}},"description_markdown":{"type":"string"},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"roles":[{"role":"CanReadResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/resource-docs/API_VERSION/obp","connector_methods":[]},{"operation_id":"OBPv2.1.0-getConsumers","implemented_by":{"version":"OBPv2.1.0","function":"getConsumers"},"request_verb":"GET","request_url":"/obp/v2.1.0/management/consumers","summary":"Get Consumers","description":"Get the all Consumers.
\nAuthentication is Mandatory
\nJSON response body fields:
\n\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: true
\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get the all Consumers.\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**app_type**](/glossary#app_type): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"list":[{"consumer_id":1213,"app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Consumer","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}}}}},"roles":[{"role":"CanGetConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/consumers","connector_methods":[]},{"operation_id":"OBPv2.0.0-getPrivateAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"getPrivateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts","summary":"Get Accounts at Bank","description":"Returns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user..
\nEach account must have at least one private View.
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Returns the list of accounts at BANK_ID that the user has access to.\nFor each account the API returns the account ID and the views available to the user..\nEach account must have at least one private View.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","PrivateData","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts","connector_methods":[]},{"operation_id":"OBPv1.2.1-getImagesForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getImagesForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Get Transaction Images","description":"Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Returns the transaction TRANSACTION_ID images made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**images**](/glossary#images): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycStatuses","implemented_by":{"version":"OBPv2.0.0","function":"getKycStatuses"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_statuses","summary":"Get Customer KYC statuses","description":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
\nAuthentication is Mandatory
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: true
\n\n","description_markdown":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): true\n\n\n\n[**statuses**](/glossary#statuses): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"statuses":[{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"statuses":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"ok":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetAnyKycStatuses","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteImageForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","summary":"Delete a Transaction Image","description":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[IMAGE_ID](/glossary#image_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20001: User not logged in. Authentication is required!","You must be able to see images in order to delete them","Image not found for this transaction","Deleting images not permitted for this view","Deleting images not permitted for the current user","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-createConsumer","implemented_by":{"version":"OBPv2.2.0","function":"createConsumer"},"request_verb":"POST","request_url":"/obp/v2.2.0/management/consumers","summary":"Post a Consumer","description":"Create a Consumer (Authenticated access).
\nAuthentication is Mandatory
\nJSON request body fields:
\n\n\nclientCertificate: clientCertificate
\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nenabled: true
\n\nJSON response body fields:
\n\n\nclientCertificate: clientCertificate
\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nenabled: true
\n\n","description_markdown":"Create a Consumer (Authenticated access).\n\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**app_type**](/glossary#app_type): \n\n\n\n[**clientCertificate**](/glossary#): clientCertificate\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**redirect_url**](/glossary#redirect_url): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**app_type**](/glossary#app_type): \n\n\n\n[**clientCertificate**](/glossary#): clientCertificate\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**redirect_url**](/glossary#redirect_url): \n\n\n","example_request_body":{"app_name":"Test","app_type":"Test","description":"Description","developer_email":"some@email.com","redirect_url":"redirecturl","created_by_user_id":"createdby","enabled":true,"created":"2024-02-27T14:01:48Z","clientCertificate":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----"},"success_response_body":{"app_name":"Some app name","app_type":"App type","description":"Description","developer_email":"some.email@example.com","redirect_url":"Some redirect url","created_by_user_id":"Created by UUID","enabled":true,"created":"2024-02-27T14:01:48Z","clientCertificate":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Consumer","Old-Style"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"description":{"type":"string"},"app_name":{"type":"string"},"clientCertificate":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"redirect_url":{"type":"string"},"app_type":{"type":"string"},"created_by_user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"description":{"type":"string"},"clientCertificate":{"type":"string"},"app_type":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"created_by_user_id":{"type":"string"},"redirect_url":{"type":"string"},"app_name":{"type":"string"}}},"roles":[{"role":"CanCreateConsumer","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/consumers","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestSandboxTan","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestSandboxTan"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","summary":"Create Transaction Request (SANDBOX_TAN)","description":"When using SANDBOX_TAN, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using SANDBOX_TAN, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SANDBOX_TAN](/glossary#sandbox_tan): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"addKycMedia"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","summary":"Add KYC Media","description":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_MEDIA_ID](/glossary#kyc_media_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"customer_number":"5987953","type":"image","url":"http://www.example.com/id-docs/123/image.png","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"123","relates_to_kyc_check_id":"123"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1100-01-01T00:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"url":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"date":{"type":"string","format":"date-time"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanAddKycMedia","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","connector_methods":[]},{"operation_id":"OBPv2.1.0-getEntitlementsByBankAndUser","implemented_by":{"version":"OBPv2.1.0","function":"getEntitlementsByBankAndUser"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/users/USER_ID/entitlements","summary":"Get Entitlements for User at Bank","description":"Get Entitlements specified by BANK_ID and USER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Get Entitlements specified by BANK_ID and USER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetEntitlementsForAnyUserAtOneBank","requires_bank_id":true},{"role":"CanGetEntitlementsForAnyUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/users/USER_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv2.0.0-getCurrentUser","implemented_by":{"version":"OBPv2.0.0","function":"getCurrentUser"},"request_verb":"GET","request_url":"/obp/v2.0.0/users/current","summary":"Get User (Current)","description":"Get the logged in user
\nLogin is required.
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get the logged in user\n\nLogin is required.\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users/current","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Update url of other bank account","description":"A url which represents the counterparty (home page url etc.)
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyImageUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Update Counterparty Image Url","description":"Update the url that points to the logo of the counterparty
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the url that points to the logo of the counterparty\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"image_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating an image url","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"image_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","implemented_by":{"version":"OBPv2.1.0","function":"getTransactionRequestTypesSupportedByBank"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-request-types","summary":"Get Transaction Request Types at Bank","description":"Get the list of the Transaction Request Types supported by the bank.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ntransaction_request_type: SEPA
\n\n","description_markdown":"Get the list of the Transaction Request Types supported by the bank.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"transaction_request_type":"SandboxTan"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Transaction-Request","Bank"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"transaction_request_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv2.2.0-updateViewForBankAccount","implemented_by":{"version":"OBPv2.2.0","function":"updateViewForBankAccount"},"request_verb":"PUT","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","summary":"Update View","description":"Update an existing view on a bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: true
\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n","description_markdown":"Update an existing view on a bank account\n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\nThe json sent is the same as during view creation (above), with one difference: the 'name' field\nof a view is not editable (it is only set when a view is created)\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): true\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n","example_request_body":{"description":"This view is for family","is_public":true,"which_alias_to_use":"family","hide_metadata_if_alias_used":false,"allowed_actions":["can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_label","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_narrative","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_edit_narrative","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_create_counterparty","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","is_public":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Account","View-Custom","Old-Style"],"typed_request_body":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getBankLevelDynamicResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/resource-docs/API_VERSION/obp","summary":"Get Bank Level Dynamic Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
Authentication is Mandatory
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nconnector_methods: connector_methods
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\n\nresource_docs: resource_docs
\nrole:
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://ifcsandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"error_response_bodies":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}},"description_markdown":{"type":"string"},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"roles":[{"role":"CanReadDynamicResourceDocsAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/resource-docs/API_VERSION/obp","connector_methods":[]},{"operation_id":"OBPv2.1.0-updateConsumerRedirectUrl","implemented_by":{"version":"OBPv2.1.0","function":"updateConsumerRedirectUrl"},"request_verb":"PUT","request_url":"/obp/v2.1.0/management/consumers/CONSUMER_ID/consumer/redirect_url","summary":"Update Consumer RedirectUrl","description":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: true
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.\n\n CONSUMER_ID can be obtained after you register the application. \n \n Or use the endpoint 'Get Consumers' to get it \n \n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**app_type**](/glossary#app_type): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"redirect_url":"http://localhost:8888"},"success_response_body":{"consumer_id":1213,"app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Consumer"],"typed_request_body":{"type":"object","properties":{"redirect_url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}},"roles":[{"role":"CanUpdateConsumerRedirectUrl","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/consumers/CONSUMER_ID/consumer/redirect_url","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycDocument","implemented_by":{"version":"OBPv2.0.0","function":"addKycDocument"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_ID","summary":"Add KYC Document","description":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc. \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_DOCUMENT_ID](/glossary#kyc_document_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"customer_number":"5987953","type":"passport","number":"12345","issue_date":"1100-01-01T00:00:00Z","issue_place":"Berlin","expiry_date":"1100-01-01T00:00:00Z"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1100-01-01T00:00:00Z","issue_place":"PlaceholderString","expiry_date":"1100-01-01T00:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","Server error: could not add KycDocument","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"issue_place":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"issue_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"type":{"type":"string"},"number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"expiry_date":{"type":"string","format":"date-time"},"issue_place":{"type":"string"},"customer_id":{"type":"string"},"type":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanAddKycDocument","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getTransactionTypes","implemented_by":{"version":"OBPv2.0.0","function":"getTransactionTypes"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/transaction-types","summary":"Get Transaction Types at Bank","description":"Get Transaction Types for the bank specified by BANK_ID:
\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\n\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nvalue: 5987953
\n","description_markdown":"Get Transaction Types for the bank specified by BANK_ID:\n\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**short_code**](/glossary#short_code): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_types**](/glossary#transaction_types): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_types":[{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_types":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyOpenCorporatesUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Delete Counterparty Open Corporates URL","description":"Delete open corporate url of other bank account
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete open corporate url of other bank account\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting an open corporate url","URL cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv2.2.0-createProduct","implemented_by":{"version":"OBPv2.2.0","function":"createProduct"},"request_verb":"PUT","request_url":"/obp/v2.2.0/banks/BANK_ID/products","summary":"Create Product","description":"Create or Update Product for the Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","description_markdown":"Create or Update Product for the Bank.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**super_family**](/glossary#super_family): \n\n\n","example_request_body":{"bank_id":"gh.29.uk","code":"prod1","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"success_response_body":{"bank_id":"gh.29.uk","code":"prod1","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product","Old-Style"],"typed_request_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"roles":[{"role":"CanCreateProduct","requires_bank_id":true},{"role":"CanCreateProductAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/products","connector_methods":[]},{"operation_id":"OBPv2.0.0-addEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"addEntitlement"},"request_verb":"POST","request_url":"/obp/v2.0.0/users/USER_ID/entitlements","summary":"Add Entitlement for a User","description":"Create Entitlement. Grant Role to User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
\nAuthentication is Mandatory
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","description_markdown":"Create Entitlement. Grant Role to User.\n\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"bank_id":"gh.29.uk","role_name":"CanCreateBranch"},"success_response_body":{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-20050: Current User is not a Super Admin!","OBP-10001: Incorrect json format.","OBP-10007: Incorrect Role name:","OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.","OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.","OBP-30216: Entitlement already exists for the user.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}},"roles":[{"role":"CanCreateEntitlementAtOneBank","requires_bank_id":true},{"role":"CanCreateEntitlementAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users/USER_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv1.4.0-getBranches","implemented_by":{"version":"OBPv1.4.0","function":"getBranches"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/branches","summary":"Get Bank Branches","description":"Returns information about branches for a single bank specified by BANK_ID including:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nYou can use the url query parameters limit and offset for pagination
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\ncity:
\ncountry: Germany
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nscheme: scheme value
\n\n","description_markdown":"Returns information about branches for a single bank specified by BANK_ID including:\n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n\n \n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\nYou can use the url query parameters *limit* and *offset* for pagination\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"branches":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"branch_routing":{"scheme":"BranchNumber","address":"678"}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","No branches available. License may not be set.","OBP-50000: Unknown Error."],"tags":["Branch","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"branches":{"type":"array","items":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/branches","connector_methods":[]},{"operation_id":"OBPv1.2.1-addPermissionForUserForBankAccountForMultipleViews","implemented_by":{"version":"OBPv1.2.1","function":"addPermissionForUserForBankAccountForMultipleViews"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","summary":"Grant User access to a list of views","description":"Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.
\nAuthentication is Mandatory
\nThe User needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nJSON request body fields:
\n\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\n\n","description_markdown":"Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.\n\nAll url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for PROVIDER_ID and PROVIDER.\n\nAuthentication is Mandatory\n\nThe User needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**views**](/glossary#views): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n","example_request_body":{"views":["_family","_work"]},"success_response_body":{"views":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","wrong format JSON","could not save the privilege","user does not have access to owner view on account"],"tags":["View-Custom","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","connector_methods":[]},{"operation_id":"OBPv2.0.0-createUser","implemented_by":{"version":"OBPv2.0.0","function":"createUser"},"request_verb":"POST","request_url":"/obp/v2.0.0/users","summary":"Create User","description":"Creates OBP user.
\nNo authorisation (currently) required.
Mimics current webform to Register.
\nRequires username(email) and password.
\nReturns 409 error if username not unique.
\nMay require validation of email address.
\nAuthentication is Mandatory
\nJSON request body fields:
\n\nfirst_name: Tom
\nlast_name: Smith
\npassword: password
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Creates OBP user.\n No authorisation (currently) required.\n\n Mimics current webform to Register.\n\n Requires username(email) and password.\n\n Returns 409 error if username not unique.\n\n May require validation of email address.\n\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**password**](/glossary#): password\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"email":"felixsmith@example.com","username":"felixsmith","password":"String","first_name":"Simon","last_name":"Redfern"},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR the length should be > 16 and <= 512.","Error occurred during user creation.","User with the same username already exists.","OBP-50000: Unknown Error."],"tags":["User","Onboarding"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"last_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users","connector_methods":[]},{"operation_id":"OBPv2.2.0-createAccount","implemented_by":{"version":"OBPv2.2.0","function":"createAccount"},"request_verb":"PUT","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Create Account","description":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
\nThe User can create an Account for themself or an Account for another User if they have CanCreateAccount role.
\nIf USER_ID is not specified the account will be owned by the logged in User.
\nThe type field should be a product_code from Product.
\nNote: The Amount must be zero.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nscheme: scheme value
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.\n\n\nThe User can create an Account for themself or an Account for another User if they have CanCreateAccount role.\n\nIf USER_ID is not specified the account will be owned by the logged in User.\n\nThe type field should be a product_code from Product.\n\nNote: The Amount must be zero.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"Label","type":"CURRENT","balance":{"currency":"EUR","amount":"0"},"branch_id":"1234","account_routing":{"scheme":"OBP","address":"UK123456"}},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"Label","type":"CURRENT","balance":{"currency":"EUR","amount":"0"},"branch_id":"1234","account_routing":{"scheme":"OBP","address":"UK123456"}},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-30107: Invalid User Id.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30106: Invalid Balance Amount.","OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00","OBP-30109: Initial Balance of Account must be Zero (0).","OBP-30105: Invalid Balance Currency.","OBP-30208: Account_ID already exists at the Bank.","OBP-50000: Unknown Error."],"tags":["Account","Onboarding"],"typed_request_body":{"type":"object","properties":{"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateAccount","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyImageUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Delete Counterparty Image URL","description":"Delete image url of other bank account
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete image url of other bank account\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyOpenCorporatesUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Update Open Corporates Url of Counterparty","description":"Update open corporate url of other bank account
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update open corporate url of other bank account\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"open_corporates_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating an open corporate url","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv2.0.0-privateAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"privateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/private","summary":"Get private accounts at one bank","description":"Returns the list of private accounts at BANK_ID that the user has access to.
\nFor each account the API returns the ID and the available views.
If you want to see more information on the Views, use the Account Detail call.
\nIf you want less information about the account, use the /my accounts call
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Returns the list of private accounts at BANK_ID that the user has access to.\nFor each account the API returns the ID and the available views.\n\nIf you want to see more information on the Views, use the Account Detail call.\nIf you want less information about the account, use the /my accounts call\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Account","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/private","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountPrivateAlias"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Get Other Account Private Alias","description":"Returns the private alias of the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the private alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"alias":"String"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow private alias access","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv1.4.0-getTransactionRequestTypes","implemented_by":{"version":"OBPv1.4.0","function":"getTransactionRequestTypes"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","summary":"Get Transaction Request Types for Account","description":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
\nThese are the ways this API Server can create a Transaction via a Transaction Request
\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)
A Transaction Request Type internally determines:
\nFor instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.
\nThis approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\n\ncurrency: EUR
\n\n\nvalue: 5987953
\n","description_markdown":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.\n\nThese are the ways this API Server can create a Transaction via a Transaction Request\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)\n\n A Transaction Request Type internally determines:\n\n * the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,\n * the type of security challenge that may be be raised before the Transaction Request proceeds, and\n * the threshold of that challenge.\n\n For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.\n\n This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.\n \n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"value":"10","charge":{"summary":"The bank fixed charge","value":{"currency":"EUR","amount":"0"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","Please specify a valid value for CURRENCY of your Bank Account. ","Current user does not have access to the view ","account not found at bank","user does not have access to owner view","OBP-40018: Sorry, Transaction Requests are not enabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"charge":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"}}},"value":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv2.1.0-getMetrics","implemented_by":{"version":"OBPv2.1.0","function":"getMetrics"},"request_verb":"GET","request_url":"/obp/v2.1.0/management/metrics","summary":"Get Metrics","description":"Get the all metrics
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) non digit chars will be silently omitted
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nverb:
\n","description_markdown":"Get the all metrics\n\nrequire CanReadMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics\n\nShould be able to filter on the following metrics fields\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2\n\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 limit (for pagination: defaults to 50) eg:limit=200\n\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\n5 sort_by (defaults to date field) eg: sort_by=date\n possible values:\n \"url\",\n \"date\",\n \"user_name\",\n \"app_name\",\n \"developer_email\",\n \"implemented_by_partial_function\",\n \"implemented_in_version\",\n \"consumer_id\",\n \"verb\"\n\n6 direction (defaults to date desc) eg: direction=desc\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78\n\nOther filters:\n\n7 consumer_id (if null ignore)\n\n8 user_id (if null ignore)\n\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n10 url (if null ignore), note: can not contain '&'.\n\n11 app_name (if null ignore)\n\n12 implemented_by_partial_function (if null ignore),\n\n13 implemented_in_version (if null ignore)\n\n14 verb (if null ignore)\n\n15 correlation_id (if null ignore)\n\n16 duration (if null ignore) non digit chars will be silently omitted\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**correlation_id**](/glossary#): 1flssoftxq0cr1nssr68u0mioj\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**duration**](/glossary#duration): 5.123\n\n\n\n[**implemented_by_partial_function**](/glossary#implemented_by_partial_function): \n\n\n\n[**implemented_in_version**](/glossary#implemented_in_version): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**verb**](/glossary#verb): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"metrics":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","url":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user_name":"OBP","app_name":"SOFI","developer_email":"felixsmith@example.com","implemented_by_partial_function":"getBanks","implemented_in_version":"v210","consumer_id":"123","verb":"get","correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1","duration":39}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"implemented_in_version":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"verb":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"date":{"type":"string","format":"date-time"},"user_name":{"type":"string"},"url":{"type":"string"},"duration":{"type":"integer"},"correlation_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanReadMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/metrics","connector_methods":[]},{"operation_id":"OBPv1.2.1-getCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"getCounterpartyPublicAlias"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Get public alias of other bank account","description":"Returns the public alias of the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is Mandatory if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the public alias of the other account OTHER_ACCOUNT_ID.\nAuthentication is Optional\nAuthentication is Mandatory if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"alias":"String"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","the view does not allow metadata access","the view does not allow public alias access","OBP-20001: User not logged in. Authentication is required!"],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv2.1.0-getProduct","implemented_by":{"version":"OBPv2.1.0","function":"getProduct"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Get Bank Product","description":"Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","description_markdown":"Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:\n\n* Name\n* Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**super_family**](/glossary#super_family): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"bank_id":"bankid123","code":"prod1","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"error_response_bodies":["OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyPhysicalLocation"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Add physical location to other bank account","description":"Add geocoordinates of the counterparty's main location
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","description_markdown":"Add geocoordinates of the counterparty's main location\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"physical_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a physical location","Coordinates not possible","Physical Location cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"deleteTransactionNarrative"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Delete a Transaction Narrative","description":"Deletes the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv2.1.0-enableDisableConsumers","implemented_by":{"version":"OBPv2.1.0","function":"enableDisableConsumers"},"request_verb":"PUT","request_url":"/obp/v2.1.0/management/consumers/CONSUMER_ID","summary":"Enable or Disable Consumers","description":"Enable/Disable a Consumer specified by CONSUMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nenabled: true
\n","description_markdown":"Enable/Disable a Consumer specified by CONSUMER_ID.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n","example_request_body":{"enabled":false},"success_response_body":{"enabled":false},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Consumer","Old-Style"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"roles":[{"role":"CanEnableConsumers","requires_bank_id":false},{"role":"CanDisableConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/management/consumers/CONSUMER_ID","connector_methods":[]},{"operation_id":"OBPv1.3.0-getCards","implemented_by":{"version":"OBPv1.3.0","function":"getCards"},"request_verb":"GET","request_url":"/obp/v1.3.0/cards","summary":"Get cards for the current user","description":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
\nAuthentication is Mandatory
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ncancelled: true
\n\ncollected: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nenabled: true
\nexpires_date: 2021-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_card_number**](/glossary#): 364435172576215\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**cancelled**](/glossary#cancelled): true\n\n\n\n[**cards**](/glossary#cards): \n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"cards":[{"bank_id":"gh.29.uk","bank_card_number":"364435172576215","name_on_card":"String","issue_number":"1","serial_number":"1324234","valid_from_date":"1100-01-01T00:00:00Z","expires_date":"1100-01-01T00:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"String","networks":["String"],"allows":["String"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1100-01-01T00:00:00Z","reason_requested":"FORGOT"}],"collected":"1100-01-01T00:00:00Z","posted":"1100-01-01T00:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"technology":{"type":"string"},"name_on_card":{"type":"string"},"enabled":{"type":"boolean"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"collected":{"type":"string","format":"date-time"},"on_hot_list":{"type":"boolean"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"expires_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"bank_card_number":{"type":"string"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"cancelled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"valid_from_date":{"type":"string","format":"date-time"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/cards","connector_methods":[]},{"operation_id":"OBPv2.0.0-corePrivateAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"corePrivateAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/my/accounts","summary":"Get Accounts at all Banks (Private)","description":"Get private accounts at all banks (Authenticated access)
\nReturns the list of accounts containing private views for the user at all banks.
\nFor each account the API returns the ID and the available views.
Authentication is Mandatory
\nJSON response body fields:
\n_links: _links
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n","description_markdown":"Get private accounts at all banks (Authenticated access)\nReturns the list of accounts containing private views for the user at all banks.\nFor each account the API returns the ID and the available views.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**_links**](/glossary#): _links\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","_links":{"jsonString":"{}"}}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","PrivateData","PSD2","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"_links":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/my/accounts","connector_methods":[]},{"operation_id":"OBPv2.1.0-getUsers","implemented_by":{"version":"OBPv2.1.0","function":"getUsers"},"request_verb":"GET","request_url":"/obp/v2.1.0/users","summary":"Get all Users","description":"Get all users
\nLogin is required.
\nCanGetAnyUser entitlement is required,
Possible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\n","description_markdown":"Get all users\n\nLogin is required.\nCanGetAnyUser entitlement is required,\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n* locked_status (if null ignore)\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/users","connector_methods":[]},{"operation_id":"OBPv2.0.0-accountById","implemented_by":{"version":"OBPv2.0.0","function":"accountById"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account","summary":"Get Account by Id (Full)","description":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
\nMore details about the data moderation by the view here.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is Mandatory if the 'is_public' field in view (VIEW_ID) is not set to true
.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\nprovider: ETHEREUM
\nscheme: scheme value
\n\n\ntype:
\n\n","description_markdown":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):\n\n* Number\n* Owners\n* Type\n* Balance\n* IBAN\n* Available views (sorted by short_name)\n\nMore details about the data moderation by the view [here](#1_2_1-getViewsForBankAccount).\n\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.\nThis call provides balance and other account information via delegated authentication using OAuth.\n\nAuthentication is Mandatory if the 'is_public' field in view (VIEW_ID) is not set to `true`.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NoneLabel","number":"123","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"type":"OBP","balance":{"currency":"EUR","amount":"0"},"IBAN":"DE89 3704 0044 0532 0130 00","swift_bic":"OKOYFIHH","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk","account_routing":{"scheme":"AccountNumber","address":"4930396"}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"label":{"type":"string"},"number":{"type":"string"},"swift_bic":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"type":{"type":"string"},"IBAN":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account","connector_methods":[]},{"operation_id":"OBPv2.1.0-getCustomersForCurrentUserAtBank","implemented_by":{"version":"OBPv2.1.0","function":"getCustomersForCurrentUserAtBank"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/customers","summary":"Get Customers for current User at Bank","description":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: true
\nlast_ok_date: 2023-02-27T14:01:45.181Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): true\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2023-02-27T14:01:45.181Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":true,"last_ok_date":"2023-02-27T14:01:45Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30008: User Customer Link not found by USER_ID","OBP-30008: User Customer Link not found by USER_ID","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/customers","connector_methods":[]},{"operation_id":"OBPv2.0.0-getPermissionsForBankAccount","implemented_by":{"version":"OBPv2.0.0","function":"getPermissionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions","summary":"Get access","description":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
\nAuthentication is Mandatory
\nand the user needs to have access to the owner view.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: true
\ncan_add_more_info: true
\n\n\n\n\ncan_add_tag: true
\n\n\n\ncan_delete_corporate_location: true
\ncan_delete_image: true
\n\n\ncan_delete_where_tag: true
\ncan_edit_owner_comment: true
\n\ncan_see_bank_account_bank_name: true
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: true
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: true
\ncan_see_bank_account_owners: true
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: true
\ncan_see_image_url: true
\ncan_see_images: true
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: true
\ncan_see_other_account_number: true
\ncan_see_other_account_swift_bic: true
\n\n\n\n\n\ncan_see_transaction_amount: true
\n\n\ncan_see_transaction_description: true
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: true
\ncan_see_where_tag: true
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\n\nprovider: ETHEREUM
\n\nuser:
\n\n","description_markdown":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.\n\nAuthentication is Mandatory\nand the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): true\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): true\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): true\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): true\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): true\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): true\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): true\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): true\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): true\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): true\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): true\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): true\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): true\n\n\n\n[**can_see_images**](/glossary#can_see_images): true\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): true\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): true\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): true\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): true\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): true\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): true\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): true\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**permissions**](/glossary#permissions): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**views**](/glossary#views): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"permissions":[{"user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"},"views":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account","User","Entitlement"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions","connector_methods":[]},{"operation_id":"OBPv1.2.1-removePermissionForUserForBankAccountForAllViews","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForAllViews"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","summary":"Revoke access to all Views on Account","description":""Revokes access to all Views on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nJSON response body fields:
\n","description_markdown":"\"Revokes access to all Views on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","user does not have access to owner view on account"],"tags":["View-Custom","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPrivateAlias"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Delete Counterparty Private Alias","description":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting the private alias","Alias cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountByIdForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","summary":"Get Other Account by Id","description":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","description_markdown":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Counterparty","Account","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv2.2.0-createCounterparty","implemented_by":{"version":"OBPv2.2.0","function":"createCounterparty"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Create Counterparty (Explicit)","description":"Create Counterparty (Explicit) for an Account.
\nIn OBP, there are two types of Counterparty.
\nExplicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
\nImplicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
\nExplicit Counterparties are created for the account / view
\nThey are how the user of the view (e.g. account owner) refers to the other side of the transaction
name : the human readable name (e.g. Piano teacher, Miss Nipa)
\ndescription : the human readable name (e.g. Piano teacher, Miss Nipa)
\nbank_routing_scheme : eg: bankId or bankCode or any other strings
\nbank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
\naccount_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
\nother_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
\nother_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
\nother_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
\nbespoke.key : any info-key you want to add to this counterparty
\nbespoke.value : any info-value you want to add to this counterparty
\nThe view specified by VIEW_ID must have the canAddCounterparty permission
\nA minimal example for TransactionRequestType == COUNTERPARTY
\n{
\n"name": "Tesobe1",
\n"description": "Good Company",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"is_beneficiary": true,
\n"other_account_secondary_routing_scheme": "",
\n"other_account_secondary_routing_address": "",
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
A minimal example for TransactionRequestType == SEPA
\n{
\n"name": "Tesobe2",
\n"description": "Good Company",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"other_account_secondary_routing_scheme": "IBAN",
\n"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
\n"is_beneficiary": true,
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: true
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address:
\n\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nvalue: 5987953
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address:
\n\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"Create Counterparty (Explicit) for an Account.\n\nIn OBP, there are two types of Counterparty.\n\n* Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests\n\n* Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.\n\nExplicit Counterparties are created for the account / view\nThey are how the user of the view (e.g. account owner) refers to the other side of the transaction\n\nname : the human readable name (e.g. Piano teacher, Miss Nipa)\n\ndescription : the human readable name (e.g. Piano teacher, Miss Nipa)\n\nbank_routing_scheme : eg: bankId or bankCode or any other strings\n\nbank_routing_address : eg: `gh.29.uk`, must be valid sandbox bankIds\n\naccount_routing_scheme : eg: AccountId or AccountNumber or any other strings\n\naccount_routing_address : eg: `1d65db7c-a7b2-4839-af41-95`, must be valid accountIds\n\nother_account_secondary_routing_scheme : eg: IBan or any other strings\n\nother_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty. \n\nother_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.\n\nother_branch_routing_address : eg: `branch-id-123` or you can leave it empty, not useful in sandbox mode.\n\nis_beneficiary : must be set to `true` in order to send payments to this counterparty\n\nbespoke: It supports a list of key-value, you can add it to the counterparty.\n\nbespoke.key : any info-key you want to add to this counterparty\n \nbespoke.value : any info-value you want to add to this counterparty\n\nThe view specified by VIEW_ID must have the canAddCounterparty permission\n\nA minimal example for TransactionRequestType == COUNTERPARTY\n {\n \"name\": \"Tesobe1\",\n \"description\": \"Good Company\",\n \"other_bank_routing_scheme\": \"OBP\",\n \"other_bank_routing_address\": \"gh.29.uk\",\n \"other_account_routing_scheme\": \"OBP\",\n \"other_account_routing_address\": \"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"is_beneficiary\": true,\n \"other_account_secondary_routing_scheme\": \"\",\n \"other_account_secondary_routing_address\": \"\",\n \"other_branch_routing_scheme\": \"\",\n \"other_branch_routing_address\": \"\",\n \"bespoke\": []\n}\n\n \nA minimal example for TransactionRequestType == SEPA\n \n {\n \"name\": \"Tesobe2\",\n \"description\": \"Good Company\",\n \"other_bank_routing_scheme\": \"OBP\",\n \"other_bank_routing_address\": \"gh.29.uk\",\n \"other_account_routing_scheme\": \"OBP\",\n \"other_account_routing_address\": \"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"other_account_secondary_routing_scheme\": \"IBAN\",\n \"other_account_secondary_routing_address\": \"DE89 3704 0044 0532 0130 00\",\n \"is_beneficiary\": true,\n \"other_branch_routing_scheme\": \"\",\n \"other_branch_routing_address\": \"\",\n \"bespoke\": []\n}\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): true\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): \n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): \n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): true\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): \n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): \n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"CounterpartyName","description":"My landlord","other_account_routing_scheme":"OBP","other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]},"success_response_body":{"name":"CounterpartyName","description":"My landlord","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"OBP","other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"typed_request_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"name":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_account_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_account_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"name":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_account_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_account_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPrivateAlias"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Update Counterparty Private Alias","description":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating the private alias","Alias cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv1.2.1-addWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addWhereTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Add a Transaction where Tag","description":"Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**where**](/glossary#where): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission:","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv2.1.0-sandboxDataImport","implemented_by":{"version":"OBPv2.1.0","function":"sandboxDataImport"},"request_verb":"POST","request_url":"/obp/v2.1.0/sandbox/data-import","summary":"Create sandbox","description":"Import bulk data into the sandbox (Authenticated access).
\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
\nThe user needs to have CanCreateSandbox entitlement.
\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
\nAn example of an import set of data (json) can be found here
\nAuthentication is Mandatory
JSON request body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\nactual_date: 2020-01-27
\n\namount: 10.12
\natms:
\nbalance: 10
\nbank:
\nbank_id: gh.29.uk
\n\n\n\n\ncity:
\ncode: 125
\ncompleted: 2020-01-27
\ncountry_code: 1254
\n\n\ncurrency: EUR
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nfull_name: full name string
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nlatitude: 38.8951
\n\n\n\n\n\nlogo: logo url
\nlongitude: -77.0364
\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\n\npassword: password
\npost_code: 789
\nposted: 2020-01-27
\n\n\n\n\n\n\ntype:
\nuser_name: felixsmith
\nusers: user list
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\naccount_number: 546387432
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\n\n","description_markdown":"Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**actual_date**](/glossary#actual_date): 2020-01-27\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**category**](/glossary#category): \n\n\n\n[**channel**](/glossary#channel): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**crm_events**](/glossary#crm_events): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**details**](/glossary#details): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**family**](/glossary#family): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**generate_accountants_view**](/glossary#generate_accountants_view): \n\n\n\n[**generate_auditors_view**](/glossary#generate_auditors_view): \n\n\n\n[**generate_public_view**](/glossary#generate_public_view): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**password**](/glossary#): password\n\n\n\n[**post_code**](/glossary#post_code): 789\n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[account_number](/glossary#): 546387432\n\n\n\n[counterparty](/glossary#counterparty): \n\n\n\n[driveUp](/glossary#driveup): \n\n\n\n[lobby](/glossary#lobby): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"banks":[{"id":"bank1","short_name":"bank 1","full_name":"Bank 1 Inc.","logo":"http://example.com/logo","website":"http://example.com"},{"id":"bank2","short_name":"bank 2","full_name":"Bank 2 Inc.","logo":"http://example.com/logo2","website":"http://example.com/2"}],"users":[{"email":"user1@example.com","password":"TESOBE520berlin123!","user_name":"User 1"},{"email":"user2@example.com","password":"TESOBE520berlin123!","user_name":"User 2"}],"accounts":[{"id":"account1","bank":"bank1","label":"Account 1 at Bank 1","number":"1","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"1234567890","owners":["User 1"],"generate_public_view":true,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account2","bank":"bank1","label":"Account 2 at Bank 1","number":"2","type":"current","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"91234567890","owners":["User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account1","bank":"bank2","label":"Account 1 at Bank 2","number":"22","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"21234567890","owners":["User 1","User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true}],"transactions":[{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank2"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartNameTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"account_number":"123456-AVB"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartAccountNumberTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Piano Repair"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-with-counterparty","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Acme Inc.","account_number":"12345-B"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank1"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}}],"branches":[{"id":"branch1","bank_id":"bank1","name":"Genel Müdürlük","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}},{"id":"branch2","bank_id":"bank1","name":"Manchester","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}],"atms":[{"id":"atm1","bank_id":"bank1","name":"Ashbourne Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"id":"atm2","bank_id":"bank1","name":"Manchester Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"products":[{"bank_id":"bank1","code":"prd1","name":"product 1","category":"cat1","family":"fam1","super_family":"sup fam 1","more_info_url":"www.example.com/index1","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"bank_id":"bank1","code":"prd2","name":"Product 2","category":"cat2","family":"fam2","super_family":"sup fam 2","more_info_url":"www.example.com/index2","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"crm_events":[{"id":"ASDFHJ47YKJH","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"},{"id":"KIFJA76876AS","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"}]},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-00002: Data import is disabled for this API instance.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Sandbox"],"typed_request_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"IBAN":{"type":"string"},"generate_accountants_view":{"type":"boolean"},"owners":{"type":"array","items":{"type":"string"}},"generate_public_view":{"type":"boolean"},"bank":{"type":"string"},"id":{"type":"string"},"generate_auditors_view":{"type":"boolean"},"label":{"type":"string"},"number":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"type":{"type":"string"}}}},"branches":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"driveUp":{"type":"object","properties":{"hours":{"type":"string"}}},"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"this_account":{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"}}},"details":{"type":"object","properties":{"value":{"type":"string"},"new_balance":{"type":"string"},"type":{"type":"string"},"completed":{"type":"string"},"posted":{"type":"string"},"description":{"type":"string"}}}}}},"products":{"type":"array","items":{"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"bank_id":{"type":"string"},"super_family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"code":{"type":"string"},"more_info_url":{"type":"string"}}}},"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"crm_events":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer":{"type":"object","properties":{"number":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"string"},"id":{"type":"string"},"detail":{"type":"string"}}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"user_name":{"type":"string"},"password":{"type":"string"}}}},"banks":{"type":"array","items":{"type":"object","properties":{"full_name":{"type":"string"},"short_name":{"type":"string"},"logo":{"type":"string"},"website":{"type":"string"},"id":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateSandbox","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/sandbox/data-import","connector_methods":[]},{"operation_id":"OBPv2.0.0-elasticSearchMetrics","implemented_by":{"version":"OBPv2.0.0","function":"elasticSearchMetrics"},"request_verb":"GET","request_url":"/obp/v2.0.0/search/metrics","summary":"Search API Metrics via Elasticsearch","description":"Search the API calls made to this API instance via Elastic Search.
\nLogin is required.
\nCanSearchMetrics entitlement is required to search metrics data.
\nparameters:
\nesType - elasticsearch type
\nsimple query:
\nq - plain_text_query
\ndf - default field to search
\nsort - field to sort on
\nsize - number of hits returned, default 10
\nfrom - show hits starting from
\njson query:
\nsource - JSON_query_(URL-escaped)
\nexample usage:
\n/search/metrics/q=findThis
\nor:
\n/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
\nNote!!
\nThe whole JSON query string MUST be URL-encoded:
\netc..
\nOnly q, source and esType are passed to Elastic
\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Search the API calls made to this API instance via Elastic Search.\n\nLogin is required.\n\nCanSearchMetrics entitlement is required to search metrics data.\n\n\nparameters:\n\n esType - elasticsearch type\n\n simple query:\n\n q - plain_text_query\n\n df - default field to search\n\n sort - field to sort on\n\n size - number of hits returned, default 10\n\n from - show hits starting from\n\n json query:\n\n source - JSON_query_(URL-escaped)\n\n\nexample usage:\n\n /search/metrics/q=findThis\n\nor:\n\n /search/metrics/source={\"query\":{\"query_string\":{\"query\":\"findThis\"}}}\n\n\nNote!!\n\nThe whole JSON query string MUST be URL-encoded:\n\n* For { use %7B\n* For } use %7D\n* For : use %3A\n* For \" use %22\n\netc..\n\n\n\nOnly q, source and esType are passed to Elastic\n\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html\n\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html\n\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API","Old-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v2.2.0/search/metrics","connector_methods":[]}]}