Bank Accounts

Returns external bank

get/sites/{site-identifier}/bank-accounts

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/bank-accounts
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Query parameters

AccountTypestring

(i.e. "EFT", "BPay", "Cheque" and return all types if parameter is blank).

SourceRecordType'FUND' | 'PERSON' | 'IDENTITY'

Return blank if the parameter is blank.

SourceRecordKeystring
Example:FundCode, person-guid, IdentityCode

SourceRecordKey a unique identifier depends on SourceRecordType.Return blank if the parameter is blank.

Response

Success

BankAccountGUIDstring guid
AccountNamestring
BSBstring
AccountNumberstring
Bankstring
Branchstring
CoContributionsAcceptedboolean
EftTraceAccountboolean
UsedForPaymentsboolean
UsedForReceiptsboolean
UsedForEFTReturnsboolean
UsedForSuperStreamboolean

Example response

[
  {
    "BankAccountGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded109",
    "AccountName": "Bank Account Name",
    "BSB": "939600",
    "AccountNumber": "1235645689",
    "Bank": "1235645689",
    "Branch": "Institutional Business",
    "CoContributionsAccepted": true,
    "EftTraceAccount": true,
    "UsedForPayments": true,
    "UsedForReceipts": true,
    "UsedForEFTReturns": true,
    "UsedForSuperStream": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.