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
Event Notification
- The ASPSP to send an event-notification resource to a TPP
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
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
Transactions
- Get Accounts Trabnsactions by AccountId
- Get Transactions

Log off

AUv1.0.0 (57 APIs)

Anfitrión de la API: https://api3.openbankproject.com

Create Account Access Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
TransactionFromDateTime: TransactionFromDateTime
TransactionToDateTime: TransactionToDateTime

JSON response body fields:

ConsentId: ConsentId
CreationDateTime: CreationDateTime
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Prev: Prev
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
TotalPages: TotalPages
TransactionFromDateTime: TransactionFromDateTime
TransactionToDateTime: TransactionToDateTime

Respuesta Exitosa Típica:

								
									{
  "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:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

obp.getBankAccountsForUser

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:

JSON response body fields:

ConsentId: ConsentId
CreationDateTime: CreationDateTime
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Prev: Prev
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
TotalPages: TotalPages
TransactionFromDateTime: TransactionFromDateTime
TransactionToDateTime: TransactionToDateTime

Respuesta Exitosa Típica:

								
									{
  "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:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

obp.getBankAccountsForUser

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:

JSON response body fields:

ConsentId: ConsentId
CreationDateTime: CreationDateTime
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Prev: Prev
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
TotalPages: TotalPages
TransactionFromDateTime: TransactionFromDateTime
TransactionToDateTime: TransactionToDateTime

Respuesta Exitosa Típica:

								
									{
  "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:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

obp.getBankAccountsForUser

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

AUv1.0.0 (57 APIs)

Create Account Access Consents

Get Account Access Consents by ConsentId

Update Account Access Consent Status by ConsentId