-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Info (root)
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Full)
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
_Book Mark Bank And Account System
- Create new Book Mark Bank And Account System
- Create new My Book Mark Bank And Account System
- Delete Book Mark Bank And Account System by id
- Delete My Book Mark Bank And Account System by id
- Get Book Mark Bank And Account System List
- Get Book Mark Bank And Account System by id
- Get My Book Mark Bank And Account System List
- Get My Book Mark Bank And Account System by id
- Update Book Mark Bank And Account System
- Update My Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
- Create new Book Mark Bank And Account
- Create new My Book Mark Bank And Account
- Delete Book Mark Bank And Account by id
- Delete My Book Mark Bank And Account by id
- Get Book Mark Bank And Account List
- Get Book Mark Bank And Account by id
- Get My Book Mark Bank And Account List
- Get My Book Mark Bank And Account by id
- Update Book Mark Bank And Account
- Update My Book Mark Bank And Account
-
API
-
Account
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
Account Public
-
Bank
-
Counterparty
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Documentation
-
Dynamic Resource Doc
-
Example test Title
-
JOPACC ATM TEST service
-
JOPACC TEST ATM 2 service
-
Swagger Petstore OpenAPI 3.1
-
Transaction
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
View Custom
- Delete Custom View
- Get Views for Account
- Get access
- Grant User access to View
- Grant User access to a list of views
- Revoke access to all Views on Account
- Revoke access to one View
-
_Book Mark Bank And Account System
- Create new Book Mark Bank And Account System
- Create new My Book Mark Bank And Account System
- Delete Book Mark Bank And Account System by id
- Delete My Book Mark Bank And Account System by id
- Get Book Mark Bank And Account System List
- Get Book Mark Bank And Account System by id
- Get My Book Mark Bank And Account System List
- Get My Book Mark Bank And Account System by id
- Update Book Mark Bank And Account System
- Update My Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
- Create new Book Mark Bank And Account
- Create new My Book Mark Bank And Account
- Delete Book Mark Bank And Account by id
- Delete My Book Mark Bank And Account by id
- Get Book Mark Bank And Account List
- Get Book Mark Bank And Account by id
- Get My Book Mark Bank And Account List
- Get My Book Mark Bank And Account by id
- Update Book Mark Bank And Account
- Update My Book Mark Bank And Account
-
_Foo Bar(simonpublic1)
- Create new Foo Bar
- Create new My Foo Bar
- Delete Foo Bar by id
- Delete My Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Get My Foo Bar List
- Get My Foo Bar by id
- Update Foo Bar
- Update My Foo Bar
-
_Hospital(mommy Map)
- Create new Hospital
- Create new My Hospital
- Delete Hospital by id
- Delete My Hospital by id
- Get Hospital List
- Get Hospital by id
- Get My Hospital List
- Get My Hospital by id
- Update Hospital
- Update My Hospital
-
_Risk Check(tobank)
- Create new My Risk Check
- Create new Risk Check
- Delete My Risk Check by id
- Delete Risk Check by id
- Get My Risk Check List
- Get My Risk Check by id
- Get Risk Check List
- Get Risk Check by id
- Update My Risk Check
- Update Risk Check
-
_Risk Checks(tobank)
- Create new My Risk Checks
- Create new Risk Checks
- Delete My Risk Checks by id
- Delete Risk Checks by id
- Get My Risk Checks List
- Get My Risk Checks by id
- Get Risk Checks List
- Get Risk Checks by id
- Update My Risk Checks
- Update Risk Checks
-
test dynamic
v1.2.1 (151 APIs)
Create new Hospital
Create new Hospital.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
-
CanCreateDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Create new My Hospital
Create new My Hospital.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete Hospital by id
Delete Hospital 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":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
-
CanDeleteDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Delete My Hospital by id
Delete My Hospital 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":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Hospital List
Get Hospital List.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Can do filter on the fields
e.g: /Hospital?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
{
"bank-id":"gh.29.uk",
"hospital_list":[{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}]
}
-
CanGetDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Hospital by id
Get Hospital by id.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
-
CanGetDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get My Hospital List
Get My Hospital List.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Can do filter on the fields
e.g: /Hospital?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
{
"bank-id":"gh.29.uk",
"hospital_list":[{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get My Hospital by id
Get My Hospital by id.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Update Hospital
Update Hospital.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
-
CanUpdateDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Update My Hospital
Update My Hospital.
Hospital
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"Hospital"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
{
"bank-id":"gh.29.uk",
"hospital":{
"hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"maternity_departments":"maternity_departments",
"labor":"labor",
"nursery":"nursery",
"maternal_and_health_awareness":"maternal_and_health_awareness",
"OB_gyn":"OB_gyn",
"pediatrician":"pediatrician",
"nutritions":"nutritions",
"psychatrichs":"psychatrichs",
"dermatology":"dermatology",
"endocrine":"endocrine",
"doctors":"doctors",
"yoga_trainers":"yoga_trainers",
"personal_trainers":"personal_trainers",
"midwife":"personal_trainers",
"IBCLC":"personal_trainers",
"lactation_counselor":"personal_trainers",
"nurses":"personal_trainers"
}
}
-
CanUpdateDynamicEntity_Hospital
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles: