API Explorer

⯆

API Explorer

My Collections

Account Access Consents
- Create Account Access Consents
- Get Account Access Consents by ConsentId
- Update Account Access Consent Status by ConsentId
Accounts
- Get Account by AccountId
- Get Accounts
Balances
- Get Accounts Balances by AccountId
- Get Balances
Beneficiaries
- Get Accounts Beneficiaries by AccountId
- Get Beneficiaries
Direct Debits
- Get Accounts Direct Debits by AccountId
- Get Direct Debits
Domestic Future Dated Payment Consents
- Create Domestic Future Dated Payment Cancellation Consents
- Create Domestic Future Dated Payment Consents
- Get Domestic Future Dated Payment Cancellation Consents by ConsentId
- Get Domestic Future Dated Payment Consents by ConsentId
Domestic Future Dated Payments
- Create Domestic Future Dated Payments
- Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId
- Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
- Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
Domestic Payments
- Create Domestic Payments
- Get Domestic Payment details by DomesticPaymentId
- Get Domestic Payments by DomesticPaymentId
Domestic Payments Consents
- Create Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation by ConsentId
- Get Domestic Payment Consents by ConsentId
Dynamic Resource Doc
- A test endpoint
Event Notification
- The ASPSP to send an event-notification resource to a TPP
Example test Title
- Create User
- Delete User
- Get User
- Get User
- Update User
File Payment Consents
- Create File Payment Consents
- Create File Payment Consents File by ConsentId
- Get File Payment Consents File by ConsentId
- Get File Payment Consents by ConsentId
File Payments
- Create File Payments
- Get File Payment Details by FilePaymentId
- Get File Payments Report File by FilePaymentId
- Get File Payments by FilePaymentId
Future Dated Payments
- Get Accounts Future Dated Payments by AccountId
- Get Future Dated Payments
International Payment Consents
- Create International Payment Consents
- Get International Payment Consents Funds Confirmation by ConsentId
- Get International Payment Consents by ConsentId
International Payments
- Create International Payments
- Get International Payment Details by InternationalPaymentId
- Get International Payments by InternationalPaymentId
JOPACC ATM TEST service
- Get Atms
JOPACC TEST ATM 2 service
- Create Atm
- Get Atms
Offers
- Get Accounts Offers by AccountId
- Get Offers
Parties
- Get Accounts Parties by AccountId
- Get Accounts Party by AccountId
- Get Party
Standing Orders
- Get Accounts Standing Orders by AccountId
- Get Standing Orders
Statements
- Get Accounts Statement Tranactions by AccountId and StatementId
- Get Accounts Statement by AccountId and StatementId
- Get Accounts Statements File by AccountId and StatementId
- Get Accounts Statements by AccountId
- Get Statements
Supplementary Account Info
- Get Accounts Supplementary Account Info by AccountId
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 Accounts Trabnsactions by AccountId
- 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

BAHRAIN-OBFv1.0.0 (134 APIs)

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

Create Account Access Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Authorised",
    "StatusUpdateDateTime":{
      
    },
    "CreationDateTime":{
      
    },
    "TransactionToDateTime":"2000-01-23T04:56:07.000+00:00",
    "Permissions":["ReadAccountsBasic","ReadAccountsBasic"],
    "ConsentId":"ConsentId",
    "TransactionFromDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

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: BAHRAIN-OBFv1.0.0, function_name: by accountAccessConsentsPost, operation_id: BAHRAIN-OBFv1.0.0-accountAccessConsentsPost Tags: Account Access Consents, Mocked-Data,

Get Account Access Consents by ConsentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Authorised",
    "StatusUpdateDateTime":{
      
    },
    "CreationDateTime":{
      
    },
    "TransactionToDateTime":"2000-01-23T04:56:07.000+00:00",
    "Permissions":["ReadAccountsBasic","ReadAccountsBasic"],
    "ConsentId":"ConsentId",
    "TransactionFromDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

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: BAHRAIN-OBFv1.0.0, function_name: by accountAccessConsentsConsentIdGet, operation_id: BAHRAIN-OBFv1.0.0-accountAccessConsentsConsentIdGet Tags: Account Access Consents, Mocked-Data,

Update Account Access Consent Status by ConsentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Authorised",
    "StatusUpdateDateTime":{
      
    },
    "CreationDateTime":{
      
    },
    "TransactionToDateTime":"2000-01-23T04:56:07.000+00:00",
    "Permissions":["ReadAccountsBasic","ReadAccountsBasic"],
    "ConsentId":"ConsentId",
    "TransactionFromDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

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: BAHRAIN-OBFv1.0.0, function_name: by accountAccessConsentsConsentIdPatch, operation_id: BAHRAIN-OBFv1.0.0-accountAccessConsentsConsentIdPatch Tags: Account Access Consents, Mocked-Data,

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

BAHRAIN-OBFv1.0.0 (134 APIs)

Create Account Access Consents

Get Account Access Consents by ConsentId

Update Account Access Consent Status by ConsentId