v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Bank Info

Get Bank Info By Id

Returns a BankInfo object with the given id.

get/api/hris/v1/bank-info/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee that appears in the third-party integration's UI.

account_numberstring nullable required

The bank account number of the employee.

routing_numberstring nullable required

Bank identifier for financial transactions in the US for an employee.

bank_namestring nullable required

The employee's bank name.

account_type'SAVINGS' | 'CHECKING' | '-' nullable required

The employee's bank account type. If the value is not one of the defined enum values, the original value passed through will be returned.

remote_created_atstring nullable required

When the bank info of third party's employee was created.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "account_number": "123456789012",
  "routing_number": "123456789",
  "bank_name": "Wells Fargo",
  "account_type": "SAVINGS",
  "remote_created_at": "2023-03-01T00:00:00Z"
}