-
AIS
- Get detailed information about user payment account
- Get detailed information about user's single transaction
- Get information about all user's payment account
- Get list of user cancelled transactions
- Get list of user done transactions
- Get list of user scheduled transactions
- Get list of user's holded operations
- Get list of user's pending transactions
- Get list of user's rejected transactions
- Removes consent
-
Dynamic Resource Doc
-
In OBP we largely define our endpoints using an internal case class or model called ResourceDocMore...
- A test endpoint
-
-
PIS
- Cancelation of future dated payment
- Cancelation of recurring payment
- Defines new recurring payment
- Get the status of bundle of payments
- Get the status of multiple payments
- Get the status of payment
- Get the status of recurring payment
- Initiate SEPA foreign transfers
- Initiate domestic transfer
- Initiate many transfers as bundle
- Initiate non SEPA foreign transfers
- Initiate tax transfer
-
AIS
-
Get detailed information about user payment account
-
Get detailed information about user's single transaction
-
Get information about all user's payment account
-
Get list of user cancelled transactions
-
Get list of user done transactions
-
Get list of user scheduled transactions
-
Get list of user's holded operations
-
Get list of user's pending transactions
-
Get list of user's rejected transactions
-
Removes consent
-
Get detailed information about user payment account
-
AS
-
Requests OAuth2 access token value
-
Requests OAuth2 authorization code
-
Requests OAuth2 authorization code based on One-time authorization code issued by External Authorization Tool
-
Requests OAuth2 access token value
-
CAF
-
Dynamic Resource Doc
-
PIS
-
Cancelation of future dated payment
-
Cancelation of recurring payment
-
Defines new recurring payment
-
Get the status of bundle of payments
-
Get the status of multiple payments
-
Get the status of payment
-
Get the status of recurring payment
-
Initiate SEPA foreign transfers
-
Initiate domestic transfer
-
Initiate many transfers as bundle
-
Initiate non SEPA foreign transfers
-
Initiate tax transfer
-
Cancelation of future dated payment
-
_CovidAPIDays
-
Create new Covid APIDays
-
Delete Covid APIDays by id
-
Get Covid APIDays List
-
Get Covid APIDays by id
-
Update Covid APIDays
-
Create new Covid APIDays
-
_Customer Cars
-
Create new Customer Cars
-
Delete Customer Cars by id
-
Get Customer Cars List
-
Get Customer Cars by id
-
Update Customer Cars
-
Create new Customer Cars
-
_D Entity1
-
_FishPort
-
_FooBar
-
_InsurancePolicy
-
Create new Insurance Policy
-
Delete Insurance Policy by id
-
Get Insurance Policy List
-
Get Insurance Policy by id
-
Update Insurance Policy
-
Create new Insurance Policy
-
_InsurancePremium
-
Create new Insurance Premium
-
Delete Insurance Premium by id
-
Get Insurance Premium List
-
Get Insurance Premium by id
-
Update Insurance Premium
-
Create new Insurance Premium
-
_MarchHare
-
Create new March Hare
-
Delete March Hare by id
-
Get March Hare List
-
Get March Hare by id
-
Update March Hare
-
Create new March Hare
-
_ObpActivity
-
Create new Obp Activity
-
Delete Obp Activity by id
-
Get Obp Activity List
-
Get Obp Activity by id
-
Update Obp Activity
-
Create new Obp Activity
-
_Odometer
-
_SimonCovid
-
Create new Simon Covid
-
Delete Simon Covid by id
-
Get Simon Covid List
-
Get Simon Covid by id
-
Update Simon Covid
-
Create new Simon Covid
-
_Sustrans
-
_Test1
PAPIv2.1.1.1 (92 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Create new Fish Port
Create new Fish Port.
Portfolio of fishbased values
Property List:
- fish: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"FishPort"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"fish_port":{
"fishPortId":"d2e8a3bf-d2ab-4256-a858-be2eb09dddff",
"fish":"James Brown",
"number":6987233228
}
}
Required Roles:
-
CanCreateDynamicEntity_FishPort
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEntity_createFishPort, operation_id: OBPv4.0.0-dynamicEntity_createFishPort
Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,
Delete Fish Port by id
Delete Fish Port 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":"FishPort"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"fish_port":{
"fishPortId":"ec1300f3-1f70-4f2a-bd49-560f83ed4a50",
"fish":"James Brown",
"number":6987233228
}
}
Required Roles:
-
CanDeleteDynamicEntity_FishPort
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEntity_deleteFishPort, operation_id: OBPv4.0.0-dynamicEntity_deleteFishPort
Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,
Get Fish Port List
Get Fish Port List.
Portfolio of fishbased values
Property List:
- fish: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"FishPort"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Can do filter on the fields
e.g: /FishPort?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:
{
"fish_port_list":[{
"fish_port":{
"fishPortId":"af825a1f-e082-4c3a-8b02-bd0673feb593",
"fish":"James Brown",
"number":6987233228
}
}]
}
Required Roles:
-
CanGetDynamicEntity_FishPort
- 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 dynamicEntity_getFishPortList, operation_id: OBPv4.0.0-dynamicEntity_getFishPortList
Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,
Get Fish Port by id
Get Fish Port by id.
Portfolio of fishbased values
Property List:
- fish: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"FishPort"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"fish_port":{
"fishPortId":"22423dd8-4bc8-42d8-a978-9d792dcce827",
"fish":"James Brown",
"number":6987233228
}
}
Required Roles:
-
CanGetDynamicEntity_FishPort
- 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 dynamicEntity_getSingleFishPort, operation_id: OBPv4.0.0-dynamicEntity_getSingleFishPort
Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,
Update Fish Port
Update Fish Port.
Portfolio of fishbased values
Property List:
- fish: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"FishPort"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"fish_port":{
"fishPortId":"860469ef-4532-4da8-9838-40b1cf27ce83",
"fish":"James Brown",
"number":6987233228
}
}
Required Roles:
-
CanUpdateDynamicEntity_FishPort
- 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:
Version: OBPv4.0.0,
function_name: by dynamicEntity_updateFishPort, operation_id: OBPv4.0.0-dynamicEntity_updateFishPort
Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,