Interfaces / BPAY

Get a list of configured bank accounts

This method requires the InterfaceExports:BpayBankAccounts permission to be associated with your role.

GET

/gb/interface/exports/bpay/bank-accounts

curl --request GET \
  --url https://api.catch-e.com/gb/interface/exports/bpay/bank-accounts \
  --header 'Authorization: <api-key>'

[
  {
    "account_name": "Example Bank Account",
    "account_name_short": "Example",
    "bank_account_bpay_mapping_id": "11988055955985160133",
    "bank_account_id": "100000"
  },
  {
    "account_name": "Another Example Bank Account",
    "account_name_short": "Another Example",
    "bank_account_bpay_mapping_id": "11988055955985160134",
    "bank_account_id": "100001"
  }
]

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Response

Success

itemsobject[]

Show child attributes

Still need help? Ask the team