Drivers / Bank Accounts

Get a driver bank account

This method requires the DriverBankAccounts:Get permission to be associated with your role

GET

/fm/driver/bank/accounts/{driver_bank_account_id}

curl --request GET \
  --url https://api.catch-e.com/fm/driver/bank/accounts/{driver_bank_account_id} \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "sp_financial_institutions": [
      {
        "financial_institution_code": "ANZ",
        "financial_institution_id": "15663073259425890304",
        "financial_institution_number": 1,
        "name": "Australia & New Zealand Banking Group Limited"
      }
    ]
  },
  "account_name": "<string>",
  "account_number": "<string>",
  "bsb": "<string>",
  "claims_access_flag": "<string>",
  "claims_default_flag": "<string>",
  "driver_bank_account_id": "<string>",
  "driver_id": "<string>",
  "status_flag": "<string>"
}

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

Path Parameters

driver_bank_account_idstringrequired

Driver Bank Account Id

Maximum string length: 20

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_embeddedobject

Show child attributes

account_namestring

account_numberstring

bsbstring

claims_access_flagstring

claims_default_flagstring

driver_bank_account_idstring

driver_idstring

status_flagstring

Still need help? Ask the team