Skip to main content

Accounts API

This resource is used to list available funding accounts and list which payment instruments are available for them for the facility associated with the Api Key used to connect to the PaymentsPlus API.

This resource can be useful to check which funding accounts are available and what types of payments can be made with those accounts.

Get accounts

Get the available funding accounts and payment methods.

Request

GET /accounts

Request body

None.

Response

Field Format Data
links Array of Links Links to related documents.
data Array of Funding Account Model A paginated list of accounts.

HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
403 FORBIDDEN Your facility may not be set up. View more.
404 NOT FOUND The fileIdentifier path parameter may be incorrect.
407 PROXY AUTHENTICATION REQUIRED This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.

Get account by details

Get the details of an account by it's account details

Request

GET /accounts/{bsbNumber}-{accountNumber}

Path Parameters

Field Format Data
bsbNumber string The BSB number of the account
accountNumber string The Account number of the account

Request body

None.

Response

Field Format Data
links Array of Links Links to related documents.
fundingAccounts Array of Funding Account Model The list of matching accounts.

Request

GET /accounts/nz/{bankCode}-{branchCode}-{accountNumber}-{suffix}

Path Parameters

Field Format Data
bankCode string The Bank Code of the account
branchCode string The Branch Code of the account
accountNumber string The Account number of the account
suffix string The Account Suffix of the account

Request body

None.

Response

Field Format Data
links Array of Links Links to related documents.
fundingAccounts Array of Funding Account Model The list of matching accounts.

HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
403 FORBIDDEN Your facility may not be set up. View more.
404 NOT FOUND The fileIdentifier path parameter may be incorrect.
407 PROXY AUTHENTICATION REQUIRED This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.

Funding Account Model

Australian Accounts

Field Format Description
type string The type of the account. domestic or international.
accountName string The name of the account.
bsbNumber string The BSB.
accountNumber string The account number.
traceBsbNumber string The trace BSB.
traceAccountNumber string The trace Account Number.
currency string The currency code.
directEntryUserId string The Direct Entry User ID of the account.
directEntryUserName string The Direct Entry User Name of the account.
defaultAccount string Flag to indicate whether this is the default account for this type. true or false.
remitterDetails A Remitter Details model. The remitter details of the account.
paymentMethods An array of Payment Methods. The available payment methods for the account.

For example:

{
    "type": "domestic",
    "accountName": "Account One",
    "bsbNumber": "032-000",
    "accountNumber": "100001",
    "traceBsbNumber": "032-001",
    "traceAccountNumber": "100002",
    "currency": "AUD",
    "directEntryUserId": "123456",
    "directEntryUserName": "DEUSER",
    "defaultAccount": "true",
    "remitterDetails": {},
    "paymentMethods": []
}

New Zealand Accounts

Field Format Description
type string The type of the account. domestic or international.
accountName string The name of the account.
bankCode string The Bank Code.
branchCode string The Branch Code.
accountNumber string The account number.
accountSuffix string The account suffix.
foreignCurrencyAccountNumber string The foreign currency account number.
currency string The currency code.
defaultAccount string Flag to indicate whether this is the default account for this type. true or false.
remitterDetails A Remitter Details model. The remitter details of the account.
paymentMethods An array of Payment Methods. The available payment methods for the account.

For example:

{
    "type": "domestic",
    "accountName": "Account One",
    "bankCode": "03",
    "branchCode": "2000",
    "accountNumber": "100001",
    "accountSuffix": "00",
    "currency": "NZD",
    "defaultAccount": "true",
    "remitterDetails": {},
    "paymentMethods": []
}

Remitter Details Model

Field Format Description
remitterName string The remitter name.
remitterAddress1 string The first line of the address.
remitterAddress2 string The second line of the address.
remitterCity string The remitter city.
remitterState string The remitter state.
remitterPostCode string The remitter post code.
remitterCountry string The remitter country. 2 character ISO country code.

For example:

{
    "remitterName": "Mr Remitter",
    "remitterAddress1": "Level 2",
    "remitterAddress2": "1 Street St",
    "remitterCity": "Sydney",
    "remitterState": "NSW",
    "remitterPostCode": "2000",
    "remitterCountry": "AU"
}

Payment Method Model

Field Format Description
methodName string The name of the payment method.
methodCode string The code of the payment method.

For example

{
    "methodName": "Australian Real Time Gross Settlement Payment",
    "methodCode": "RTGS"
}

Payment Methods

The following are the payment methods available in the PaymentsPlus API.

Method Code Method Name
DIRECT_ENTRY Australian Direct Entry Payment (EFT)
RTGS Australian Real Time Gross Settlement Payment
BPAY Australian BPay Payment
AU_OTT Australian Overseas Telegraphic Transfer
AU_ACH_EFT Australian Automated Clearing House EFT
NZ_DIRECT_ENTRY New Zealand Direct Entry Payment
NZ_OTT New Zealand Overseas Telegraphic Transfer
Disclaimer

The information contained in this publication is provided for learning purposes only and is subject to change. Revisions may be issued from time to time that encompass changes or additions to this module.

This is a guide only and it is not comprehensive. It does not impinge on or overrule any formal arrangement you may enter into with the Bank. The Bank and its officers shall not have any liability for any losses of any kind incurred in connection with any action, inaction or decision taken in reliance on the information herein or for any inaccuracies, errors or omissions. In this publication references to the "Bank" are to Westpac Banking Corporation ABN 33 007 457 141 and to any of its operating Divisions, including BankSA and St.George.