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 Standing Orders

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON response body fields:

AccountId: AccountId
Amount: 10.12
CreditorAgent: CreditorAgent
Currency: EUR
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
FinalPaymentAmount: FinalPaymentAmount
FinalPaymentDateTime: FinalPaymentDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
FirstPaymentAmount: FirstPaymentAmount
FirstPaymentDateTime: FirstPaymentDateTime
Frequency: 5
Identification: Identification
Last: Last
[Links](/glossary#User Customer Links): Links
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
NextPaymentAmount: NextPaymentAmount
NextPaymentDateTime: NextPaymentDateTime
Prev: Prev
Reference: Reference
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StandingOrder: StandingOrder
StandingOrderId: StandingOrderId
StandingOrderStatusCode: StandingOrderStatusCode
SupplementaryData: SupplementaryData
TotalPages: TotalPages

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":{
    "StandingOrder":[{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification"
      },
      "AccountId":{
        
      },
      "StandingOrderId":"StandingOrderId",
      "Reference":"Reference",
      "StandingOrderStatusCode":{
        
      },
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "FirstPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "NextPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "Frequency":"Frequency",
      "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"
    },{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification"
      },
      "AccountId":{
        
      },
      "StandingOrderId":"StandingOrderId",
      "Reference":"Reference",
      "StandingOrderStatusCode":{
        
      },
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "FirstPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "NextPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "Frequency":"Frequency",
      "FirstPaymentDateTime":"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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getStandingOrders, operation_id: UKv3.1-getStandingOrders Tags: Standing Orders, Mocked-Data,

Get Standing Orders

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

AccountId: AccountId
Amount: 10.12
CreditorAgent: CreditorAgent
Currency: EUR
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
FinalPaymentAmount: FinalPaymentAmount
FinalPaymentDateTime: FinalPaymentDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
FirstPaymentAmount: FirstPaymentAmount
FirstPaymentDateTime: FirstPaymentDateTime
Frequency: 5
Identification: Identification
Last: Last
[Links](/glossary#User Customer Links): Links
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
NextPaymentAmount: NextPaymentAmount
NextPaymentDateTime: NextPaymentDateTime
Prev: Prev
Reference: Reference
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StandingOrder: StandingOrder
StandingOrderId: StandingOrderId
StandingOrderStatusCode: StandingOrderStatusCode
SupplementaryData: SupplementaryData
TotalPages: TotalPages

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":{
    "StandingOrder":[{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification"
      },
      "AccountId":{
        
      },
      "StandingOrderId":"StandingOrderId",
      "Reference":"Reference",
      "StandingOrderStatusCode":{
        
      },
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "FirstPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "NextPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "Frequency":"Frequency",
      "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00"
    },{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification"
      },
      "AccountId":{
        
      },
      "StandingOrderId":"StandingOrderId",
      "Reference":"Reference",
      "StandingOrderStatusCode":{
        
      },
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "FirstPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "NextPaymentAmount":{
        "Amount":{
          
        },
        "Currency":"Currency"
      },
      "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
      "Frequency":"Frequency",
      "FirstPaymentDateTime":"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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getAccountsAccountIdStandingOrders, operation_id: UKv3.1-getAccountsAccountIdStandingOrders Tags: Standing Orders, 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 Standing Orders

Get Standing Orders