API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Party

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":{ "Party":{ "PartyNumber":"PartyNumber", "PartyId":"PartyId", "Address":[{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" },{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" }], "Phone":"Phone", "Mobile":"Mobile", "PartyType":{ }, "EmailAddress":"EmailAddress", "Name":"Name" } } }
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 getAccountsAccountIdParty, operation_id: UKv3.1-getAccountsAccountIdParty Tags: Partys, Mocked-Data,

Get Party

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":{ "Party":{ "PartyNumber":"PartyNumber", "PartyId":"PartyId", "Address":[{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" },{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" }], "Phone":"Phone", "Mobile":"Mobile", "PartyType":{ }, "EmailAddress":"EmailAddress", "Name":"Name" } } }
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 getParty, operation_id: UKv3.1-getParty Tags: Partys, Mocked-Data,