UpdateDriverBankAccountsList

Allows you to update driver bank accounts.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on DriverBankAccounts:Update.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

Use the HTTP Method 'PUT' for consuming this web service.

URL Examples

https://api.catch-e.com/bank/accounts

Body (JSON)

The request body should contain an array of bank account objects to update.

JSON

Field Format

Notes

Mandatory

driver_bank_account_id

string

Unique identifier for the bank account record

Yes

account_name

string

Name of the bank account holder

No

claims_access_flag

string

Flag to allow claims access. Values: yes, no

No

claims_default_flag

string

Flag to set as default for claims. Values: yes, no

No

status_flag

string

Account status. Values: active, inactive

No

JSON Example

Single bank account update:

{ "driver_bank_account_id": "100001", "account_name": "Primary Account", "claims_access_flag": "yes", "claims_default_flag": "yes", "status_flag": "active" }

Multiple bank accounts update:

[ { "driver_bank_account_id": "100001", "account_name": "Primary Account", "claims_access_flag": "yes", "claims_default_flag": "yes", "status_flag": "active" }, { "driver_bank_account_id": "100002", "account_name": "Secondary Account", "claims_access_flag": "no", "claims_default_flag": "no", "status_flag": "active" } ]

Response Details

Validation Message

Comments

200 OK

Successful response returns the updated bank account details

Successful Response Example

{ "driver_bank_account_id": "string", "driver_id": "string", "supplier_id": "string", "account_name": "string", "bsb": "string", "account_number": "string", "claims_default_flag": "no", "status_flag": "active" }

The response includes:

  • driver_bank_account_id: Unique identifier for the bank account

  • driver_id: Associated driver ID

  • supplier_id: Associated supplier ID if applicable

  • account_name: Name of the account holder

  • bsb: Bank State Branch number

  • account_number: Account number

  • claims_default_flag: Whether this is the default for claims

  • status_flag: Current status of the account