AUv1.0.0 (22 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Customer

NOTE: This endpoint currently only returns example data.

        Obtain basic information on the customer that has authorised the current session

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "data":{ "person":{ "middleNames":["middleNames","middleNames"], "firstName":"firstName", "lastName":"lastName", "occupationCode":"occupationCode", "prefix":"prefix", "suffix":"suffix", "lastUpdateTime":"lastUpdateTime" }, "organisation":{ "agentRole":"agentRole", "agentLastName":"agentLastName", "establishmentDate":"establishmentDate", "businessName":"businessName", "registeredCountry":"registeredCountry", "abn":"abn", "acn":"acn", "industryCode":"industryCode", "organisationType":"SOLE_TRADER", "legalName":"legalName", "isACNCRegistered":true, "agentFirstName":"agentFirstName", "shortName":"shortName", "lastUpdateTime":"lastUpdateTime" }, "customerUType":"person" }, "meta":" ", "links":{ "self":"self" } }
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: AUv1.0.0, function_name: by getCustomer, operation_id: AUv1.0.0-getCustomer Tags: Common, Customer, Mocked-Data,

Get Customer Detail

NOTE: This endpoint currently only returns example data.

        Obtain detailed information on the authorised customer within the current session.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "data":{ "person":"", "organisation":"", "customerUType":"person" }, "meta":" ", "links":{ "self":"self" } }
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: AUv1.0.0, function_name: by getCustomerDetail, operation_id: AUv1.0.0-getCustomerDetail Tags: Common, Customer, Mocked-Data,

Get Outages

NOTE: This endpoint currently only returns example data.

        Obtain a list of scheduled outages for the implementation

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "data":{ "outages":[{ "duration":"duration", "outageTime":"outageTime", "isPartial":true, "explanation":"explanation" },{ "duration":"duration", "outageTime":"outageTime", "isPartial":true, "explanation":"explanation" }] }, "meta":" ", "links":{ "self":"self" } }
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: AUv1.0.0, function_name: by getOutages, operation_id: AUv1.0.0-getOutages Tags: Common, Discovery, Mocked-Data,

Get Status

NOTE: This endpoint currently only returns example data.

        Obtain a health check status for the implementation

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "data":{ "updateTime":"updateTime", "explanation":"explanation", "expectedResolutionTime":"expectedResolutionTime", "detectionTime":"detectionTime", "status":"OK" }, "meta":" ", "links":{ "self":"self" } }
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: AUv1.0.0, function_name: by getStatus, operation_id: AUv1.0.0-getStatus Tags: Common, Discovery, Mocked-Data,