Bank Info
The BankInfo object is used to represent the Bank Account information for an Employee.
Properties

idUUID
Required

remote_idString
Optional
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.

employeeUUID
Optional
The employee with this bank account.

account_numberString
Optional
The account number.

routing_numberString
Optional
The routing number.

bank_nameString
Optional
The bank name.

account_typeEnum
Optional
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.

remote_created_atDateTime (ISO 8601)
Optional
When the matching bank object was created in the third party system.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

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_typeString
Optional
If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')

bank_nameString
Optional
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.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
If provided, will only return bank accounts for this employee.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

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_byString
Optional
Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

show_enum_originsString
Optional
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 fields
Use the /linked-accounts endpoint to pull platform support information
Breathe
Breathe
Charlie
Charlie
Factorial
Factorial
Freshteam
Freshteam
Hailey HR
Hailey HR
Hibob
Hibob
Humaans
Humaans
Kenjo
Kenjo
Lucca
Lucca
PayCaptain
PayCaptain
Paychex
Paychex
Paycor
Paycor
Paylocity
Paylocity
PeopleHR
PeopleHR
SAP SuccessFactors
SAP SuccessFactors
TriNet HR Platform
TriNet HR Platform
UKG Pro
UKG Pro
UKG Ready
UKG Ready
ADP Workforce Now
ADP Workforce Now
Coming soon
AlexisHR
AlexisHR
Coming soon
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

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
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 fields
Use the /linked-accounts endpoint to pull platform support information
Breathe
Breathe
Charlie
Charlie
Factorial
Factorial
Freshteam
Freshteam
Hailey HR
Hailey HR
Hibob
Hibob
Humaans
Humaans
Kenjo
Kenjo
Lucca
Lucca
PayCaptain
PayCaptain
Paychex
Paychex
Paycor
Paycor
Paylocity
Paylocity
PeopleHR
PeopleHR
SAP SuccessFactors
SAP SuccessFactors
TriNet HR Platform
TriNet HR Platform
UKG Pro
UKG Pro
UKG Ready
UKG Ready
ADP Workforce Now
ADP Workforce Now
Coming soon
AlexisHR
AlexisHR
Coming soon