Employment Hero

Employment Hero Employee Bank Account API

Employee Bank Accounts

GitHub OpenAPI

Operations 5

GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount List Bank Accounts #
POST /api/v2/business/{businessId}/employee/{employeeId}/bankaccount Create Bank Account #
GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId} Get Bank Account by ID #
PUT /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId} Update Bank Account #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId} Delete Bank Account #

Documentation

📖
Documentation
https://api.keypay.com.au/guides/Home.html
📖
APIReference
https://api.keypay.com.au/
📖
APIReference
https://api.keypay.com.au/new-zealand/reference.html
📖
APIReference
https://api.keypay.com.au/united-kingdom/reference.html
📖
APIReference
https://api.keypay.com.au/singapore/reference.html
📖
APIReference
https://api.keypay.com.au/malaysia/reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-employeebankaccount-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/employment-hero:employment-hero-employeebankaccount-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

employment-hero-employeebankaccount-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Employee Bank Account API
  version: '1.0'
  description: 'Operations tagged EmployeeBankAccount across 5 of this provider''s published API definitions: employment-hero-payroll-au-swagger.json, employment-hero-payroll-my-swagger.json, employment-hero-payroll-nz-swagger.json, employment-hero-payroll-sg-swagger.json, employment-hero-payroll-uk-swagger.json. Each path carries the servers of the definition it was published in.'
security:
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
tags:
- name: EmployeeBankAccount
  description: Employee Bank Accounts
paths:
  /api/v2/business/{businessId}/employee/{employeeId}/bankaccount:
    get:
      tags:
      - EmployeeBankAccount
      summary: List Bank Accounts
      description: Lists all of the bank accounts for this employee.
      operationId: AuBankAccount_List
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IEnumerable<AuBankAccountModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuBankAccountModel'
            application/xml:
              schema:
                title: IEnumerable<AuBankAccountModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuBankAccountModel'
            text/plain:
              schema:
                title: IEnumerable<AuBankAccountModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuBankAccountModel'
            application/octet-stream:
              schema:
                title: IEnumerable<AuBankAccountModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuBankAccountModel'
            text/json:
              schema:
                title: IEnumerable<AuBankAccountModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuBankAccountModel'
    post:
      tags:
      - EmployeeBankAccount
      summary: Create Bank Account
      description: Creates a new bank account for the employee.
      operationId: AuBankAccount_Post
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
  /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}:
    get:
      tags:
      - EmployeeBankAccount
      summary: Get Bank Account by ID
      description: Gets the bank account for this employee with the specified ID.
      operationId: AuBankAccount_Get_2
      parameters:
      - in: path
        name: bankAccountId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuBankAccountModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuBankAccountModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuBankAccountModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuBankAccountModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuBankAccountModel'
    put:
      tags:
      - EmployeeBankAccount
      summary: Update Bank Account
      description: Updates the employee's bank account with the specified ID.
      operationId: AuBankAccount_Put_3
      parameters:
      - in: path
        name: bankAccountId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuBankAccountModel'
    delete:
      tags:
      - EmployeeBankAccount
      summary: Delete Bank Account
      description: Deletes the employee's bank account with the specified ID.
      operationId: AuBankAccount_Delete_4
      parameters:
      - in: path
        name: bankAccountId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuSaveBankAccountResponseModel'
components:
  schemas:
    AuBankAccountModel:
      title: AuBankAccountModel
      type: object
      properties:
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          - Bpay
          type: string
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        bsb:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        allocatedPercentage:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        fixedAmount:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        allocateBalance:
          title: Boolean
          type: boolean
          x-title: Boolean
        isEmployeeEditable:
          title: Boolean
          type: boolean
          x-title: Boolean
        canBeDeleted:
          title: Boolean
          type: boolean
          x-title: Boolean
        externalReferenceId:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    AuSaveBankAccountResponseModel:
      title: AuSaveBankAccountResponseModel
      type: object
      properties:
        validationWarning:
          title: String
          type: string
          x-title: String
        result:
          $ref: '#/components/schemas/AuBankAccountModel'
      additionalProperties: false
    MyBankAccountModel:
      title: MyBankAccountModel
      type: object
      properties:
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        branchCode:
          title: String
          type: string
          x-title: String
        bankCode:
          title: String
          type: string
          x-title: String
        otherBankName:
          title: String
          type: string
          x-title: String
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        bsb:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        allocatedPercentage:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        fixedAmount:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        allocateBalance:
          title: Boolean
          type: boolean
          x-title: Boolean
        isEmployeeEditable:
          title: Boolean
          type: boolean
          x-title: Boolean
        canBeDeleted:
          title: Boolean
          type: boolean
          x-title: Boolean
        externalReferenceId:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    MySaveBankAccountResponseModel:
      title: MySaveBankAccountResponseModel
      type: object
      properties:
        validationWarning:
          title: String
          type: string
          x-title: String
        result:
          $ref: '#/components/schemas/MyBankAccountModel'
      additionalProperties: false
    NzBankAccountModel:
      title: NzBankAccountModel
      type: object
      properties:
        fullAccountNumber:
          title: String
          type: string
          x-title: String
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        accountCode:
          title: String
          type: string
          x-title: String
        accountParticulars:
          title: String
          type: string
          x-title: String
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        bsb:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        allocatedPercentage:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        fixedAmount:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        allocateBalance:
          title: Boolean
          type: boolean
          x-title: Boolean
        isEmployeeEditable:
          title: Boolean
          type: boolean
          x-title: Boolean
        canBeDeleted:
          title: Boolean
          type: boolean
          x-title: Boolean
        externalReferenceId:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    NzSaveBankAccountResponseModel:
      title: NzSaveBankAccountResponseModel
      type: object
      properties:
        validationWarning:
          title: String
          type: string
          x-title: String
        result:
          $ref: '#/components/schemas/NzBankAccountModel'
      additionalProperties: false
    SgSaveBankAccountResponseModel:
      title: SgSaveBankAccountResponseModel
      type: object
      properties:
        validationWarning:
          title: String
          type: string
          x-title: String
        result:
          $ref: '#/components/schemas/SgBankAccountModel'
      additionalProperties: false
    SgBankAccountModel:
      title: SgBankAccountModel
      type: object
      properties:
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        bankSwift:
          title: String
          type: string
          x-title: String
        branchCode:
          title: String
          type: string
          x-title: String
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        bsb:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        allocatedPercentage:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        fixedAmount:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        allocateBalance:
          title: Boolean
          type: boolean
          x-title: Boolean
        isEmployeeEditable:
          title: Boolean
          type: boolean
          x-title: Boolean
        canBeDeleted:
          title: Boolean
          type: boolean
          x-title: Boolean
        externalReferenceId:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    UkSaveBankAccountResponseModel:
      title: UkSaveBankAccountResponseModel
      type: object
      properties:
        validationWarning:
          title: String
          type: string
          x-title: String
        result:
          $ref: '#/components/schemas/UkBankAccountModel'
      additionalProperties: false
    UkBankAccountModel:
      title: UkBankAccountModel
      type: object
      properties:
        accountType:
          title: BankAccountTypeEnum
          enum:
          - Electronic
          - ManualDeposit
          - CashOrCheque
          type: string
          x-title: BankAccountTypeEnum
        rollNumber:
          title: String
          type: string
          x-title: String
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        employeeId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        bsb:
          title: String
          type: string
          x-title: String
        accountName:
          title: String
          type: string
          x-title: String
        accountNumber:
          title: String
          type: string
          x-title: String
        allocatedPercentage:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        fixedAmount:
          format: double
          title: Nullable<Decimal>
          type: number
          x-title: Nullable<Decimal>
        allocateBalance:
          title: Boolean
          type: boolean
          x-title: Boolean
        isEmployeeEditable:
          title: Boolean
          type: boolean
          x-title: Boolean
        canBeDeleted:
          title: Boolean
          type: boolean
          x-title: Boolean
        externalReferenceId:
          title: String
          type: string
          x-title: String
      additionalProperties: false
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Your API key should be the username and the password can be left blank
    apiKey:
      type: apiKey
      in: header
      description: API Key Authentication
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://keypay.yourpayroll.com.au/oauth/authorise
      description: OAuth2 Implicit Grant
x-refined-from:
- employment-hero-payroll-au-swagger.json
- employment-hero-payroll-my-swagger.json
- employment-hero-payroll-nz-swagger.json
- employment-hero-payroll-sg-swagger.json
- employment-hero-payroll-uk-swagger.json