-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
-
-
Account Access
-
Accounts
-
Balances
-
Bank Accounts (Dynamic Endpoint)
-
Beneficiaries
-
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
-
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
-
Partys
-
Products
-
Scheduled Payments
-
Standing Orders
-
Statements
-
Transactions
-
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
-
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
-
_D Entity1(gh.29.uk)
-
_Fish Port
-
_Foo Bar
-
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
-
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
-
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
-
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
-
_Odometer(gh.29.uk)
-
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
-
_Sustrans
-
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
-
_Test1
v3.1 (144 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Create Domestic Scheduled Payment 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
},
"Risk":{
"PaymentContextCode":{
},
"DeliveryAddress":{
"StreetName":"StreetName",
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"PostCode":"PostCode"
},
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"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":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Permission":{
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"InstructedAmount":{
"Currency":"Currency"
},
"CreditorPostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
}
},
"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
}
}
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 createDomesticScheduledPaymentConsents, operation_id: UKv3.1-createDomesticScheduledPaymentConsents
Tags: Domestic Scheduled Payments, Mocked-Data,
Create Domestic Scheduled Payments
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",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"DomesticScheduledPaymentId":"DomesticScheduledPaymentId",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"InstructedAmount":{
"Currency":"Currency"
},
"CreditorPostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
}
},
"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00",
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
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 createDomesticScheduledPayments, operation_id: UKv3.1-createDomesticScheduledPayments
Tags: Domestic Scheduled Payments, Mocked-Data,
Get Domestic Scheduled Payment Consents
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
CONSENTID: CONSENTID
JSON response body fields:
Typical Successful Response:
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Risk":{
"PaymentContextCode":{
},
"DeliveryAddress":{
"StreetName":"StreetName",
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"PostCode":"PostCode"
},
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"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":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Permission":{
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"InstructedAmount":{
"Currency":"Currency"
},
"CreditorPostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
}
},
"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
}
}
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 getDomesticScheduledPaymentConsentsConsentId, operation_id: UKv3.1-getDomesticScheduledPaymentConsentsConsentId
Tags: Domestic Scheduled Payments, Mocked-Data,
Get Domestic Scheduled Payments
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
DOMESTICSCHEDULEDPAYMENTID: DOMESTICSCHEDULEDPAYMENTID
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",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"DomesticScheduledPaymentId":"DomesticScheduledPaymentId",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":["UK.OBIE.BACS","UK.OBIE.BalanceTransfer","UK.OBIE.CHAPS","UK.OBIE.Euro1","UK.OBIE.FPS","UK.OBIE.Link","UK.OBIE.MoneyTransfer","UK.OBIE.Paym","UK.OBIE.SEPACreditTransfer","UK.OBIE.SEPAInstantCreditTransfer","UK.OBIE.SWIFT","UK.OBIE.Target2"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"InstructedAmount":{
"Currency":"Currency"
},
"CreditorPostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
}
},
"ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00",
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
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 getDomesticScheduledPaymentsDomesticScheduledPaymentId, operation_id: UKv3.1-getDomesticScheduledPaymentsDomesticScheduledPaymentId
Tags: Domestic Scheduled Payments, Mocked-Data,