API Explorer
-
Banking
- Get Account Balance
- Get Account Detail
- Get Accounts
- Get Balances For Specific Accounts
- Get Bulk Balances
- Get Bulk Direct Debits
- Get Direct Debits For Account
- Get Direct Debits For Specific Accounts
- Get Payee Detail
- Get Payees
- Get Product Detail
- Get Products
- Get Scheduled Payments Bulk
- Get Scheduled Payments For Specific Accounts
- Get Scheduled Payments for Account
- Get Transaction Detail
- Get Transactions For Account
- Common
-
Banking
- Get Account Balance
- Get Account Detail
- Get Accounts
- Get Balances For Specific Accounts
- Get Bulk Balances
- Get Bulk Direct Debits
- Get Direct Debits For Account
- Get Direct Debits For Specific Accounts
- Get Payee Detail
- Get Payees
- Get Product Detail
- Get Products
- Get Scheduled Payments Bulk
- Get Scheduled Payments For Specific Accounts
- Get Scheduled Payments for Account
- Get Transaction Detail
- Get Transactions For Account
-
Common
AUv1.0.0 (21 APIs)
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:
-
abn: abn
-
acn: acn
-
agentFirstName: agentFirstName
-
agentLastName: agentLastName
-
agentRole: agentRole
-
businessName: businessName
-
customerUType: customerUType
-
[data](/glossary#Data Model Overview): data
-
establishmentDate: establishmentDate
-
firstName: firstName
-
industryCode: industryCode
-
isACNCRegistered: isACNCRegistered
-
jvalueToCaseclass: jvalueToCaseclass
-
lastName: lastName
-
lastUpdateTime: lastUpdateTime
-
legalName: legalName
-
[links](/glossary#User Customer Links): links
-
middleNames: middleNames
-
occupationCode: occupationCode
-
organisationType: organisationType
-
person: person
-
prefix: prefix
-
registeredCountry: registeredCountry
-
self: self
-
shortName: shortName
-
suffix: suffix
{
"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"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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:
-
customerUType: customerUType
-
[data](/glossary#Data Model Overview): data
-
jvalueToCaseclass: jvalueToCaseclass
-
[links](/glossary#User Customer Links): links
-
person: person
-
self: self
{
"data":{
"person":"",
"organisation":"",
"customerUType":"person"
},
"meta":" ",
"links":{
"self":"self"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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:
-
[data](/glossary#Data Model Overview): data
-
explanation: explanation
-
isPartial: isPartial
-
jvalueToCaseclass: jvalueToCaseclass
-
[links](/glossary#User Customer Links): links
-
outageTime: outageTime
-
outages: outages
-
self: self
{
"data":{
"outages":[{
"duration":"duration",
"outageTime":"outageTime",
"isPartial":true,
"explanation":"explanation"
},{
"duration":"duration",
"outageTime":"outageTime",
"isPartial":true,
"explanation":"explanation"
}]
},
"meta":" ",
"links":{
"self":"self"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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:
-
[data](/glossary#Data Model Overview): data
-
detectionTime: detectionTime
-
expectedResolutionTime: expectedResolutionTime
-
explanation: explanation
-
jvalueToCaseclass: jvalueToCaseclass
-
[links](/glossary#User Customer Links): links
-
self: self
-
updateTime: updateTime
{
"data":{
"updateTime":"updateTime",
"explanation":"explanation",
"expectedResolutionTime":"expectedResolutionTime",
"detectionTime":"detectionTime",
"status":"OK"
},
"meta":" ",
"links":{
"self":"self"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.