-
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)
Bank
Accounts
Views
Counterparties
Transactions
Create User
Create User
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEndpointProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"url_pattern",
"value":"http://https://obp-apisandbox.joinfincubator.com/user/save"
},
{
"key":"http_method",
"value":"POST"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"id":1,
"first_name":"string",
"last_name":"string",
"age":1,
"career":"string"
}
Required Roles:
-
CanCreateDynamicEndpoint_User469
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEndpoint_POST_save, operation_id: OBPv4.0.0-dynamicEndpoint_POST_save
Tags: Example test Title, Dynamic-Endpoint, Dynamic,
Delete User
Delete user by user ID
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEndpointProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"url_pattern",
"value":"http://https://obp-apisandbox.joinfincubator.com/user/delete/{userId}"
},
{
"key":"http_method",
"value":"DELETE"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
"the successful delete user by user ID"
Required Roles:
-
CanDeleteDynamicEndpoint_User972
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEndpoint_DELETE_delete_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_delete_USER_ID
Tags: Example test Title, Dynamic-Endpoint, Dynamic,
Get User
Get list of users
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEndpointProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"url_pattern",
"value":"http://https://obp-apisandbox.joinfincubator.com/user/listUsers"
},
{
"key":"http_method",
"value":"GET"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"id":1,
"first_name":"string",
"last_name":"string",
"age":1,
"career":"string"
}
Required Roles:
-
CanGetDynamicEndpoint_User187
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEndpoint_GET_listUsers, operation_id: OBPv4.0.0-dynamicEndpoint_GET_listUsers
Tags: Example test Title, Dynamic-Endpoint, Dynamic,
Get User
Get reuested user by user ID
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEndpointProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"url_pattern",
"value":"http://https://obp-apisandbox.joinfincubator.com/user/getById/{userId}"
},
{
"key":"http_method",
"value":"GET"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"id":1,
"first_name":"string",
"last_name":"string",
"age":1,
"career":"string"
}
Required Roles:
-
CanGetDynamicEndpoint_User202
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEndpoint_GET_getById_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_getById_USER_ID
Tags: Example test Title, Dynamic-Endpoint, Dynamic,
Update User
Update User
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEndpointProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"url_pattern",
"value":"http://https://obp-apisandbox.joinfincubator.com/user/updateUser"
},
{
"key":"http_method",
"value":"PUT"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"id":1,
"first_name":"string",
"last_name":"string",
"age":1,
"career":"string"
}
Required Roles:
-
CanUpdateDynamicEndpoint_User114
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEndpoint_PUT_updateUser, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_updateUser
Tags: Example test Title, Dynamic-Endpoint, Dynamic,