API Explorer

v4.0.0 (422 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Mocked Bank

Create new Mocked Bank.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"MockedBank"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "mocked_bank":{ "mockedBankId":"e652787d-559b-4c2e-abe5-b4a71dc0af62", "id":"gh.29.uk", "short_name":"short_name", "full_name":"full_name", "logo":"logo", "website":"website" } }
Required Roles:
  • CanCreateDynamicEntity_MockedBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_createMockedBank, operation_id: OBPv4.0.0-dynamicEntity_createMockedBank

Delete Mocked Bank by id

Delete Mocked Bank by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"MockedBank"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "mocked_bank":{ "mockedBankId":"8e5b93bf-9640-463b-a83f-b6d528f564bf", "id":"gh.29.uk", "short_name":"short_name", "full_name":"full_name", "logo":"logo", "website":"website" } }
Required Roles:
  • CanDeleteDynamicEntity_MockedBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_deleteMockedBank, operation_id: OBPv4.0.0-dynamicEntity_deleteMockedBank

Get Mocked Bank List

Get Mocked Bank List.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"MockedBank"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /MockedBank?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response:

								
									
{ "mocked_bank_list":[{ "mocked_bank":{ "mockedBankId":"27e6f80f-3ae6-4ef7-a527-17b8f70cb345", "id":"gh.29.uk", "short_name":"short_name", "full_name":"full_name", "logo":"logo", "website":"website" } }] }
Required Roles:
  • CanGetDynamicEntity_MockedBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_getMockedBankList, operation_id: OBPv4.0.0-dynamicEntity_getMockedBankList

Get Mocked Bank by id

Get Mocked Bank by id.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"MockedBank"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "mocked_bank":{ "mockedBankId":"0b6dce97-5338-458b-89f3-cf3da85de5fc", "id":"gh.29.uk", "short_name":"short_name", "full_name":"full_name", "logo":"logo", "website":"website" } }
Required Roles:
  • CanGetDynamicEntity_MockedBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_getSingleMockedBank, operation_id: OBPv4.0.0-dynamicEntity_getSingleMockedBank

Update Mocked Bank

Update Mocked Bank.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"MockedBank"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "mocked_bank":{ "mockedBankId":"94671c06-49a8-4035-8c0f-db173e4c7c44", "id":"gh.29.uk", "short_name":"short_name", "full_name":"full_name", "logo":"logo", "website":"website" } }
Required Roles:
  • CanUpdateDynamicEntity_MockedBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_updateMockedBank, operation_id: OBPv4.0.0-dynamicEntity_updateMockedBank