API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Offers

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

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":{ "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":{ } }] } }
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 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:

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":{ "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":{ } }] } }
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 getAccountsAccountIdOffers, operation_id: UKv3.1-getAccountsAccountIdOffers Tags: Offers, Mocked-Data,