-
Account Access
-
Account Access is OBP View system. The Account owners can create the view themselves. And they canMore...
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
-
-
Account Access
-
Accounts
-
Balances
-
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
-
Create Domestic Payment Consents
-
Domestic Scheduled Payments
-
Create Domestic Scheduled Payment Consents
-
Create Domestic Scheduled Payments
-
Get Domestic Scheduled Payment Consents
-
Get Domestic Scheduled Payments
-
Create Domestic Scheduled Payment Consents
-
Domestic Standing Orders
-
Create Domestic Standing Order Consents
-
Create Domestic Standing Orders
-
Get Domestic Standing Order Consents
-
Get Domestic Standing Orders
-
Create Domestic Standing Order Consents
-
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
-
Create File Payment Consents
-
Funds Confirmations
-
Create Funds Confirmation
-
Create Funds Confirmation Consent
-
Delete Funds Confirmation Consent
-
Get Funds Confirmation Consent
-
Create Funds Confirmation
-
International Payments
-
Create International Payment Consents
-
Create International Payments
-
Get International Payment Consents
-
Get International Payment Consents Funds Confirmation
-
Get International Payments
-
Create International Payment Consents
-
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
-
Create International Scheduled Payment Consents
-
International Standing Orders
-
Create International Standing Order Consents
-
Create International Standing Orders
-
Get International Standing Order Consents
-
Get International Standing Orders
-
Create International Standing Order Consents
-
Offers
-
Partys
-
Products
-
Scheduled Payments
-
Standing Orders
-
Statements
-
Transactions
v3.1 (67 APIs)
Get Beneficiaries
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON response body fields:
-
AccountId: AccountId
-
AddressLine: AddressLine
-
AddressType: AddressType
-
Beneficiary: Beneficiary
-
BeneficiaryId: BeneficiaryId
-
BuildingNumber: BuildingNumber
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
CreditorAgent: CreditorAgent
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
Department: Department
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
Identification: Identification
-
Last: Last
-
[Links](/glossary#User Customer Links): Links
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
PostalAddress: PostalAddress
-
Prev: Prev
-
Reference: Reference
-
SchemeName: SchemeName
-
SecondaryIdentification: SecondaryIdentification
-
Self: Self
-
StreetName: StreetName
-
SubDepartment: SubDepartment
-
TotalPages: TotalPages
-
TownName: TownName
{
"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":{
"Beneficiary":[{
"CreditorAgent":{
"PostalAddress":{
"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"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"AccountId":{
},
"Reference":"Reference",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"BeneficiaryId":"BeneficiaryId"
},{
"CreditorAgent":{
"PostalAddress":{
"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"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"AccountId":{
},
"Reference":"Reference",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"BeneficiaryId":"BeneficiaryId"
}]
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Beneficiaries
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
- ACCOUNTID: ACCOUNTID
JSON response body fields:
-
AccountId: AccountId
-
AddressLine: AddressLine
-
AddressType: AddressType
-
Beneficiary: Beneficiary
-
BeneficiaryId: BeneficiaryId
-
BuildingNumber: BuildingNumber
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
CreditorAgent: CreditorAgent
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
Department: Department
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
Identification: Identification
-
Last: Last
-
[Links](/glossary#User Customer Links): Links
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
PostalAddress: PostalAddress
-
Prev: Prev
-
Reference: Reference
-
SchemeName: SchemeName
-
SecondaryIdentification: SecondaryIdentification
-
Self: Self
-
StreetName: StreetName
-
SubDepartment: SubDepartment
-
TotalPages: TotalPages
-
TownName: TownName
{
"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":{
"Beneficiary":[{
"CreditorAgent":{
"PostalAddress":{
"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"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"AccountId":{
},
"Reference":"Reference",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"BeneficiaryId":"BeneficiaryId"
},{
"CreditorAgent":{
"PostalAddress":{
"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"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"AccountId":{
},
"Reference":"Reference",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"BeneficiaryId":"BeneficiaryId"
}]
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.