API Explorer

v4.0.0 (417 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":"ca9d7df9-c689-45ef-8c79-b8baa6788a9e", "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":"ed425f2c-07cb-4d7d-85a7-98b01a8a0b7e", "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":"3e7ebc22-0fe9-4cac-ac27-3ac1f442eee1", "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":"5d7e9b9d-67f3-42c9-bcca-7a807645829f", "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":"ca1f35c2-223b-480f-ad57-9c61fb886395", "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