API Explorer

v4.0.0 (402 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Dynamic Entity

Create a DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CRUD endpoints will be generated automatically

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField6": {
    "type": "reference:Bank",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField7": {
    "type": "reference:Consumer",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField8": {
    "type": "reference:Customer",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField9": {
    "type": "reference:MethodRouting",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField10": {
    "type": "reference:DynamicEntity",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField11": {
    "type": "reference:TransactionRequest",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField12": {
    "type": "reference:ProductAttribute",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField13": {
    "type": "reference:AccountAttribute",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField14": {
    "type": "reference:TransactionAttribute",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField15": {
    "type": "reference:CustomerAttribute",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField16": {
    "type": "reference:AccountApplication",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField17": {
    "type": "reference:CardAttribute",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField18": {
    "type": "reference:Counterparty",
    "example": "76891db8-782c-4360-a535-841cd05b119f"
}

"someField19": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&branchId=2ea696b7-c344-41b8-8d86-fd8837304098"
}

"someField20": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&atmId=2ea696b7-c344-41b8-8d86-fd8837304098"
}

"someField21": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&accountId=2ea696b7-c344-41b8-8d86-fd8837304098"
}

"someField22": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&productCode=2ea696b7-c344-41b8-8d86-fd8837304098"
}

"someField23": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&cardId=2ea696b7-c344-41b8-8d86-fd8837304098"
}

"someField24": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&accountId=2ea696b7-c344-41b8-8d86-fd8837304098&transactionId=282a0ac1-15ec-4d56-926d-0b0ca0b479e1"
}

"someField25": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=76891db8-782c-4360-a535-841cd05b119f&accountId=2ea696b7-c344-41b8-8d86-fd8837304098&counterpartyId=282a0ac1-15ec-4d56-926d-0b0ca0b479e1"
}

Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanCreateDynamicEntity - 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 createDynamicEntity, operation_id: OBPv4.0.0-createDynamicEntity

Delete Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEntity - 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.
Implemented in OBPv4.0.0 by deleteDynamicEntity, operation_id: OBPv4.0.0-deleteDynamicEntity

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by deleteMyDynamicEntity, operation_id: OBPv4.0.0-deleteMyDynamicEntity

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetBankLevelDynamicEntities - 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 getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities

Get Dynamic Entities

Get the all Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetDynamicEntities - 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 getDynamicEntities, operation_id: OBPv4.0.0-getDynamicEntities

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getMyDynamicEntities, operation_id: OBPv4.0.0-getMyDynamicEntities

Update Dynamic Entity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField6": {
    "type": "reference:Bank",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField7": {
    "type": "reference:Consumer",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField8": {
    "type": "reference:Customer",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField9": {
    "type": "reference:MethodRouting",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField10": {
    "type": "reference:DynamicEntity",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField11": {
    "type": "reference:TransactionRequest",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField12": {
    "type": "reference:ProductAttribute",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField13": {
    "type": "reference:AccountAttribute",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField14": {
    "type": "reference:TransactionAttribute",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField15": {
    "type": "reference:CustomerAttribute",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField16": {
    "type": "reference:AccountApplication",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField17": {
    "type": "reference:CardAttribute",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField18": {
    "type": "reference:Counterparty",
    "example": "170f9858-9024-4008-91a5-bfc1d727a601"
}

"someField19": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&branchId=0ac41616-f905-4d0f-8b79-132fe19d1f33"
}

"someField20": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&atmId=0ac41616-f905-4d0f-8b79-132fe19d1f33"
}

"someField21": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&accountId=0ac41616-f905-4d0f-8b79-132fe19d1f33"
}

"someField22": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&productCode=0ac41616-f905-4d0f-8b79-132fe19d1f33"
}

"someField23": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&cardId=0ac41616-f905-4d0f-8b79-132fe19d1f33"
}

"someField24": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&accountId=0ac41616-f905-4d0f-8b79-132fe19d1f33&transactionId=12b14691-7240-4ed4-b6d4-fadf19f1ac43"
}

"someField25": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=170f9858-9024-4008-91a5-bfc1d727a601&accountId=0ac41616-f905-4d0f-8b79-132fe19d1f33&counterpartyId=12b14691-7240-4ed4-b6d4-fadf19f1ac43"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanUpdateDynamicEntity - 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 updateDynamicEntity, operation_id: OBPv4.0.0-updateDynamicEntity

Update My Dynamic Entity

Update my DynamicEntity.

Authentication is Mandatory

Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support filed types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField6": {
    "type": "reference:Bank",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField7": {
    "type": "reference:Consumer",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField8": {
    "type": "reference:Customer",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField9": {
    "type": "reference:MethodRouting",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField10": {
    "type": "reference:DynamicEntity",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField11": {
    "type": "reference:TransactionRequest",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField12": {
    "type": "reference:ProductAttribute",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField13": {
    "type": "reference:AccountAttribute",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField14": {
    "type": "reference:TransactionAttribute",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField15": {
    "type": "reference:CustomerAttribute",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField16": {
    "type": "reference:AccountApplication",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField17": {
    "type": "reference:CardAttribute",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField18": {
    "type": "reference:Counterparty",
    "example": "67dae639-abe3-4103-8291-45fd77ddd25a"
}

"someField19": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&branchId=21023e45-9e11-4b21-8cbd-d264b102c902"
}

"someField20": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&atmId=21023e45-9e11-4b21-8cbd-d264b102c902"
}

"someField21": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&accountId=21023e45-9e11-4b21-8cbd-d264b102c902"
}

"someField22": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&productCode=21023e45-9e11-4b21-8cbd-d264b102c902"
}

"someField23": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&cardId=21023e45-9e11-4b21-8cbd-d264b102c902"
}

"someField24": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&accountId=21023e45-9e11-4b21-8cbd-d264b102c902&transactionId=4fc4b4f9-5dca-4b2f-97ac-14890163b70a"
}

"someField25": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=67dae639-abe3-4103-8291-45fd77ddd25a&accountId=21023e45-9e11-4b21-8cbd-d264b102c902&counterpartyId=4fc4b4f9-5dca-4b2f-97ac-14890163b70a"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by updateMyDynamicEntity, operation_id: OBPv4.0.0-updateMyDynamicEntity