API Explorer

v4.0.0 (329 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Dynamic Entity

Create a DynamicEntity.

Authentication is Mandatory

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

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": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField5": {
    "type": "reference:Bank",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField6": {
    "type": "reference:Consumer",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField7": {
    "type": "reference:Customer",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField8": {
    "type": "reference:MethodRouting",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField9": {
    "type": "reference:DynamicEntity",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField10": {
    "type": "reference:TransactionRequest",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField11": {
    "type": "reference:ProductAttribute",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField12": {
    "type": "reference:AccountAttribute",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField13": {
    "type": "reference:TransactionAttribute",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField14": {
    "type": "reference:CustomerAttribute",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField15": {
    "type": "reference:AccountApplication",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField16": {
    "type": "reference:CardAttribute",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField17": {
    "type": "reference:Counterparty",
    "example": "33d0168a-82c4-46cf-a5a8-86985622f4a2"
}

"someField18": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&branchId=1c9c0318-e963-40af-abff-356124cb415f"
}

"someField19": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&atmId=1c9c0318-e963-40af-abff-356124cb415f"
}

"someField20": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&accountId=1c9c0318-e963-40af-abff-356124cb415f"
}

"someField21": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&productCode=1c9c0318-e963-40af-abff-356124cb415f"
}

"someField22": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&cardId=1c9c0318-e963-40af-abff-356124cb415f"
}

"someField23": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&accountId=1c9c0318-e963-40af-abff-356124cb415f&transactionId=f0084889-294a-4e55-b392-1fac36b08c1f"
}

"someField24": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=33d0168a-82c4-46cf-a5a8-86985622f4a2&accountId=1c9c0318-e963-40af-abff-356124cb415f&counterpartyId=f0084889-294a-4e55-b392-1fac36b08c1f"
}

Typical Successful Response:

								
									
{ "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" }
Required Roles:
  • CanCreateDynamicEntity - Please login to request this Role
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.
Implemented in OBPv4.0.0 by 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
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

Get Dynamic Entities

Get the all Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "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" }] }
Required Roles:
  • CanGetDynamicEntities - Please login to request this Role
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 getDynamicEntities

Update Dynamic Entity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CURD 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": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField5": {
    "type": "reference:Bank",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField6": {
    "type": "reference:Consumer",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField7": {
    "type": "reference:Customer",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField8": {
    "type": "reference:MethodRouting",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField9": {
    "type": "reference:DynamicEntity",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField10": {
    "type": "reference:TransactionRequest",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField11": {
    "type": "reference:ProductAttribute",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField12": {
    "type": "reference:AccountAttribute",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField13": {
    "type": "reference:TransactionAttribute",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField14": {
    "type": "reference:CustomerAttribute",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField15": {
    "type": "reference:AccountApplication",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField16": {
    "type": "reference:CardAttribute",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField17": {
    "type": "reference:Counterparty",
    "example": "bc8ab87e-77c8-4610-863a-40bd5417a2f2"
}

"someField18": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&branchId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9"
}

"someField19": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&atmId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9"
}

"someField20": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&accountId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9"
}

"someField21": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&productCode=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9"
}

"someField22": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&cardId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9"
}

"someField23": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&accountId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9&transactionId=16a9e3a0-5238-4c88-950f-21b90f487455"
}

"someField24": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=bc8ab87e-77c8-4610-863a-40bd5417a2f2&accountId=070b0afd-ebb7-4529-8d04-4aaf9fb6e8e9&counterpartyId=16a9e3a0-5238-4c88-950f-21b90f487455"
}

Typical Successful Response:

								
									
{ "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" }
Required Roles:
  • CanUpdateDynamicEntity - Please login to request this Role
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.
Implemented in OBPv4.0.0 by updateDynamicEntity