API Explorer
- Account Access
- Accounts
- Balances
- Beneficiaries
- Direct Debits
- Domestic Payments
- Domestic Scheduled Payments
- Domestic Standing Orders
- File Payments
- Funds Confirmations
- International Payments
- International Scheduled Payments
- International Standing Orders
- Offers
- Partys
- Products
- Scheduled Payments
- Standing Orders
- Statements
- Transactions
-
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
-
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
-
Partys
-
Products
-
Scheduled Payments
-
Standing Orders
-
Statements
-
Transactions
v3.1 (67 APIs)
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#Data Model Overview): Data
-
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
-
Value: 5987953
-
jvalueToCaseclass: jvalueToCaseclass
{
"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":{
}
}]
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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#Data Model Overview): Data
-
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
-
Value: 5987953
-
jvalueToCaseclass: jvalueToCaseclass
{
"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":{
}
}]
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.