Bank Info
The
BankInfo object is used to represent the Bank Account information for an Employee.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employeeUUIDOptional
The employee with this bank account.
account_numberStringOptional
The account number.
routing_numberStringOptional
The routing number.
bank_nameStringOptional
The bank name.
account_typeEnumOptional
The bank account type Possible values include:
SAVINGS, CHECKING. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_created_atDateTime (ISO 8601)Optional
When the matching bank object was created in the third party system.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/bank-info
https://api.merge.dev/api/hris/v1/bank-info
US
EU
APAC
Returns a list of BankInfo objects.
Query & Path Parameters
account_typeStringOptional
If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
bank_nameStringOptional
If provided, will only return BankInfo's with this bank name.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
employee_idStringOptional
If provided, will only return bank accounts for this employee.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
order_byStringOptional
Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Charlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Factorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Freshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
Hailey HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
Kenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDrouting_numberString
Lucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
PayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDrouting_numberString
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Paycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
PeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
Planday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_dataRemoteData[]pathstringdatastring
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_created_atDateTime (ISO 8601)remote_idStringrouting_numberString
TriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberString
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberString
ADP Workforce Now
AlexisHR
GET
/bank-info/{id}
https://api.merge.dev/api/hris/v1/bank-info/{id}
US
EU
APAC
Returns a BankInfo object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringCharlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringFactorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringFreshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringHailey HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringHibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringHumaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringKenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDrouting_numberStringLucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringPayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDrouting_numberStringPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringPaycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringPaylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringPeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringPlanday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringemployeeUUIDremote_created_atDateTime (ISO 8601)remote_idStringrouting_numberStringTriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringUKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringrouting_numberStringUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
account_numberStringaccount_typeEnumbank_nameStringemployeeUUIDremote_dataRemoteData[]pathstringdatastringrouting_numberStringADP Workforce Now
AlexisHR