-
Banking
- Get Account Balance
- Get Account Detail
- Get Accounts
- Get Balances For Specific Accounts
- Get Bulk Balances
- Get Bulk Direct Debits
- Get Direct Debits For Account
- Get Direct Debits For Specific Accounts
- Get Payee Detail
- Get Payees
- Get Product Detail
- Get Products
- Get Scheduled Payments Bulk
- Get Scheduled Payments For Specific Accounts
- Get Scheduled Payments for Account
- Get Transaction Detail
- Get Transactions For Account
-
Bank Accounts (Dynamic Endpoint)
-
Banking
- Get Account Balance
- Get Account Detail
- Get Accounts
- Get Balances For Specific Accounts
- Get Bulk Balances
- Get Bulk Direct Debits
- Get Direct Debits For Account
- Get Direct Debits For Specific Accounts
- Get Payee Detail
- Get Payees
- Get Product Detail
- Get Products
- Get Scheduled Payments Bulk
- Get Scheduled Payments For Specific Accounts
- Get Scheduled Payments for Account
- Get Transaction Detail
- Get Transactions For Account
-
Common
-
Dynamic Resource Doc
-
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update 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
-
_D Entity1(gh.29.uk)
-
_Fish Port
-
_Foo Bar
-
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
-
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
-
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
-
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
-
_Odometer(gh.29.uk)
-
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
-
_Sustrans
-
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
-
_Test1
AUv1.0.0 (99 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Get Customer
NOTE: This endpoint currently only returns example data.
Obtain basic information on the customer that has authorised the current session
Authentication is Mandatory
JSON response body fields:
Typical Successful Response:
{
"data":{
"person":{
"middleNames":["middleNames","middleNames"],
"firstName":"firstName",
"lastName":"lastName",
"occupationCode":"occupationCode",
"prefix":"prefix",
"suffix":"suffix",
"lastUpdateTime":"lastUpdateTime"
},
"organisation":{
"agentRole":"agentRole",
"agentLastName":"agentLastName",
"establishmentDate":"establishmentDate",
"businessName":"businessName",
"registeredCountry":"registeredCountry",
"abn":"abn",
"acn":"acn",
"industryCode":"industryCode",
"organisationType":"SOLE_TRADER",
"legalName":"legalName",
"isACNCRegistered":true,
"agentFirstName":"agentFirstName",
"shortName":"shortName",
"lastUpdateTime":"lastUpdateTime"
},
"customerUType":"person"
},
"meta":" ",
"links":{
"self":"self"
}
}
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:
Version: AUv1.0.0,
function_name: by getCustomer, operation_id: AUv1.0.0-getCustomer
Tags: Common, Customer, Mocked-Data,
Get Customer Detail
NOTE: This endpoint currently only returns example data.
Obtain detailed information on the authorised customer within the current session.
Authentication is Mandatory
JSON response body fields:
Typical Successful Response:
{
"data":{
"person":"",
"organisation":"",
"customerUType":"person"
},
"meta":" ",
"links":{
"self":"self"
}
}
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:
Version: AUv1.0.0,
function_name: by getCustomerDetail, operation_id: AUv1.0.0-getCustomerDetail
Tags: Common, Customer, Mocked-Data,
Get Outages
NOTE: This endpoint currently only returns example data.
Obtain a list of scheduled outages for the implementation
Authentication is Mandatory
JSON response body fields:
Typical Successful Response:
{
"data":{
"outages":[{
"duration":"duration",
"outageTime":"outageTime",
"isPartial":true,
"explanation":"explanation"
},{
"duration":"duration",
"outageTime":"outageTime",
"isPartial":true,
"explanation":"explanation"
}]
},
"meta":" ",
"links":{
"self":"self"
}
}
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:
Version: AUv1.0.0,
function_name: by getOutages, operation_id: AUv1.0.0-getOutages
Tags: Common, Discovery, Mocked-Data,
Get Status
NOTE: This endpoint currently only returns example data.
Obtain a health check status for the implementation
Authentication is Mandatory
JSON response body fields:
Typical Successful Response:
{
"data":{
"updateTime":"updateTime",
"explanation":"explanation",
"expectedResolutionTime":"expectedResolutionTime",
"detectionTime":"detectionTime",
"status":"OK"
},
"meta":" ",
"links":{
"self":"self"
}
}
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:
Version: AUv1.0.0,
function_name: by getStatus, operation_id: AUv1.0.0-getStatus
Tags: Common, Discovery, Mocked-Data,