Drivers / Bank Accounts

Create bank accounts for drivers

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

POST

/fm/driver/bank/accounts

curl --request POST \
  --url https://api.catch-e.com/fm/driver/bank/accounts \
  --header 'Authorization: <api-key>' \
  --header 'Delegated-Locking-Session-Id: <string>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "account_name": "<string>",
    "account_number": "<string>",
    "bsb": "<string>",
    "claims_access_flag": "yes",
    "claims_default_flag": "no",
    "driver_id": "<string>",
    "status_flag": "active"
  }
]
'

{
  "_embedded": {
    "fm_driver_bank_accounts": [
      {
        "_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>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/driver/bank/accounts"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

Headers

Delegated-Locking-Session-Idstringheader

(Optional) Locking responsibility will be delegated to the specified Session Id.

This header enables the client to instruct the API to merely verify the presence of locks with the specified session id, but not attempt to obtain them itself. It requires the DelegatedLocking permission to be associated with your role.

Maximum string length: 32

Pattern: ^[0-9a-f]{32}

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Body

JSON payload

itemsobject[]

Show child attributes

Response

Driver Bank Account created successfully

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team