API Explorer

⯆

API Explorer

My Collections

Account Access
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
Accounts
- Get Accounts
- Get Accounts
Balances
- Get Balances
- Get Balances
Beneficiaries
- Get Beneficiaries
- Get Beneficiaries
Direct Debits
- Get Direct Debits
- Get Direct Debits
Domestic Payments
- Create Domestic Payment Consents
- Create Domestic Payments
- Get Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation
- Get Domestic Payments
Domestic Scheduled Payments
- Create Domestic Scheduled Payment Consents
- Create Domestic Scheduled Payments
- Get Domestic Scheduled Payment Consents
- Get Domestic Scheduled Payments
Domestic Standing Orders
- Create Domestic Standing Order Consents
- Create Domestic Standing Orders
- Get Domestic Standing Order Consents
- Get Domestic Standing Orders
Dynamic Resource Doc
- A test endpoint
Example test Title
- Create User
- Delete User
- Get User
- Get User
- Update User
File Payments
- Create File Payment Consents
- Create File Payment Consents
- Create File Payments
- Get File Payment Consents
- Get File Payment Consents
- Get File Payments
- Get File Payments
Funds Confirmations
- Create Funds Confirmation
- Create Funds Confirmation Consent
- Delete Funds Confirmation Consent
- Get Funds Confirmation Consent
International Payments
- Create International Payment Consents
- Create International Payments
- Get International Payment Consents
- Get International Payment Consents Funds Confirmation
- Get International Payments
International Scheduled Payments
- Create International Scheduled Payment Consents
- Create International Scheduled Payments
- Get International Scheduled Payment Consents
- Get International Scheduled Payment Consents Funds Confirmation
- Get International Scheduled Payments
International Standing Orders
- Create International Standing Order Consents
- Create International Standing Orders
- Get International Standing Order Consents
- Get International Standing Orders
JOPACC ATM TEST service
- Get Atms
JOPACC TEST ATM 2 service
- Create Atm
- Get Atms
Offers
- Get Offers
- Get Offers
Partys
- Get Party
- Get Party
Products
- Get Products
- Get Products
Scheduled Payments
- Get Scheduled Payments
- Get Scheduled Payments
Standing Orders
- Get Standing Orders
- Get Standing Orders
Statements
- Get Statements
- Get Statements
- Get Statements
- Get Statements
- Get Transactions
- Get Transactions
Swagger Petstore OpenAPI 3.1
- Add A New Pet To The Store
- Deletes A Pet
- Find Pet By Id
- Update An Existing Pet
Transactions
- Get Transactions
- Get Transactions
_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
- Get Bank Account By Id
- Get Bank Account By Id
- Post Accounts
- Post Accounts

Log off

v3.1 (144 APIs)

API Host: https://obp-apisandbox.joinfincubator.com

Create Account Access Consents

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "Data":{
    "ConsentId":"string",
    "CreationDateTime":"2020-10-20T08:40:47.375Z",
    "Status":"Authorised",
    "StatusUpdateDateTime":"2020-10-20T08:40:47.375Z",
    "Permissions":["ReadAccountsBasic"],
    "ExpirationDateTime":"2020-10-20T08:40:47.375Z",
    "TransactionFromDateTime":"2020-10-20T08:40:47.375Z",
    "TransactionToDateTime":"2020-10-20T08:40:47.375Z"
  },
  "Risk":{
    
  },
  "Links":{
    "Self":"https://obp-apisandbox.joinfincubator.com/open-banking/v3.1/account-access-consents/CONSENT_ID"
  },
  "Meta":{
    "TotalPages":0,
    "FirstAvailableDateTime":"2020-10-20T08:40:47.375Z",
    "LastAvailableDateTime":"2020-10-20T08:40:47.375Z"
  }
}

Request Headers:

Response Headers:

Required Roles:

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: UKv3.1, function_name: by createAccountAccessConsents, operation_id: UKv3.1-createAccountAccessConsents Tags: Account Access,

Delete Account Access Consents

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Required Roles:

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: UKv3.1, function_name: by deleteAccountAccessConsentsConsentId, operation_id: UKv3.1-deleteAccountAccessConsentsConsentId Tags: Account Access,

Get Account Access Consents

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									{
  "Data":{
    "ConsentId":"string",
    "CreationDateTime":"2020-10-20T10:28:39.801Z",
    "Status":"Authorised",
    "StatusUpdateDateTime":"2020-10-20T10:28:39.801Z",
    "Permissions":["ReadAccountsBasic"],
    "ExpirationDateTime":"2020-10-20T10:28:39.801Z",
    "TransactionFromDateTime":"2020-10-20T10:28:39.801Z",
    "TransactionToDateTime":"2020-10-20T10:28:39.801Z"
  },
  "Risk":"",
  "Links":{
    "Self":"https://obp-apisandbox.joinfincubator.com/open-banking/v3.1/account-access-consents/CONSENT_ID"
  },
  "Meta":{
    "TotalPages":0,
    "FirstAvailableDateTime":"2020-10-20T10:28:39.801Z",
    "LastAvailableDateTime":"2020-10-20T10:28:39.801Z"
  }
}

Request Headers:

Response Headers:

Required Roles:

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: UKv3.1, function_name: by getAccountAccessConsentsConsentId, operation_id: UKv3.1-getAccountAccessConsentsConsentId Tags: Account Access,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v3.1 (144 APIs)

Create Account Access Consents

Delete Account Access Consents

Get Account Access Consents