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
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
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
Transactions
- Get Transactions
- Get Transactions

Log off

v3.1 (67 APIs)

API Host: https://api3.openbankproject.com

Get Offers

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON response body fields:

AccountId: AccountId
Amount: 10.12
Currency: EUR
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
Description: This an optional field. Maximum length is 2000. It can be any characters here.
EndDateTime: EndDateTime
Fee: Fee
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Offer: Offer
OfferId: OfferId
OfferType: OfferType
Prev: Prev
Rate: Rate
Self: Self
StartDateTime: StartDateTime
Term: Term
TotalPages: TotalPages
URL: http://www.example.com/id-docs/123/image.png
Value: 5987953

Typical Successful Response

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou",
    "First":"http://example.com/aeiou"
  },
  "Data":{
    "Offer":[{
      "OfferId":"OfferId",
      "AccountId":{
        
      },
      "Description":"Description",
      "StartDateTime":"2000-01-23T04:56:07.000+00:00",
      "EndDateTime":"2000-01-23T04:56:07.000+00:00",
      "Rate":"Rate",
      "Amount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Fee":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Value":0,
      "Term":"Term",
      "URL":"URL",
      "OfferType":{
        
      }
    },{
      "OfferId":"OfferId",
      "AccountId":{
        
      },
      "Description":"Description",
      "StartDateTime":"2000-01-23T04:56:07.000+00:00",
      "EndDateTime":"2000-01-23T04:56:07.000+00:00",
      "Rate":"Rate",
      "Amount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Fee":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Value":0,
      "Term":"Term",
      "URL":"URL",
      "OfferType":{
        
      }
    }]
  }
}

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getOffers, operation_id: UKv3.1-getOffers Tags: Offers, Mocked-Data,

Get Offers

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

AccountId: AccountId
Amount: 10.12
Currency: EUR
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
Description: This an optional field. Maximum length is 2000. It can be any characters here.
EndDateTime: EndDateTime
Fee: Fee
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Offer: Offer
OfferId: OfferId
OfferType: OfferType
Prev: Prev
Rate: Rate
Self: Self
StartDateTime: StartDateTime
Term: Term
TotalPages: TotalPages
URL: http://www.example.com/id-docs/123/image.png
Value: 5987953

Typical Successful Response

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou",
    "First":"http://example.com/aeiou"
  },
  "Data":{
    "Offer":[{
      "OfferId":"OfferId",
      "AccountId":{
        
      },
      "Description":"Description",
      "StartDateTime":"2000-01-23T04:56:07.000+00:00",
      "EndDateTime":"2000-01-23T04:56:07.000+00:00",
      "Rate":"Rate",
      "Amount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Fee":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Value":0,
      "Term":"Term",
      "URL":"URL",
      "OfferType":{
        
      }
    },{
      "OfferId":"OfferId",
      "AccountId":{
        
      },
      "Description":"Description",
      "StartDateTime":"2000-01-23T04:56:07.000+00:00",
      "EndDateTime":"2000-01-23T04:56:07.000+00:00",
      "Rate":"Rate",
      "Amount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Fee":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "Value":0,
      "Term":"Term",
      "URL":"URL",
      "OfferType":{
        
      }
    }]
  }
}

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getAccountsAccountIdOffers, operation_id: UKv3.1-getAccountsAccountIdOffers Tags: Offers, 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

v3.1 (67 APIs)

Get Offers

Get Offers