Bank Info

The BankInfo object is used to represent the Bank Account information for an Employee. This is often referenced with an Employee object.

The BankInfo object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional

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, or - in cases where there is no clear mapping - the original value passed through.

remote_created_atString
Optional
When the matching bank object was created in the third party system.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The BankInfo object
JSON
{
"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
"remote_id": "123234",
"employee": "a3617eb4-dfe3-426f-921e-a65fc1661e10",
"account_number": "439291590",
"routing_number": "089690059",
"bank_name": "Chase",
"account_type": "CHECKING",
"remote_created_at": "2021-12-06T10:11:26Z",
"remote_data": [
{
"path": "/bank-info",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}

GET

/bank-info

Returns a list of BankInfo objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
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_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

order_byString
Optional
Overrides the default ordering for this endpoint.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

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

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
"remote_id": "123234",
"employee": "a3617eb4-dfe3-426f-921e-a65fc1661e10",
"account_number": "439291590",
"routing_number": "089690059",
"bank_name": "Chase",
"account_type": "CHECKING",
"remote_created_at": "2021-12-06T10:11:26Z",
"remote_data": [
{
"path": "/bank-info",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
]
}
Field support by platform

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

remote_dataRemoteData[]

routing_numberString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_created_atString

remote_dataRemoteData[]

remote_idString

routing_numberString

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString

PayCaptain

PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

routing_numberString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

employeeString

remote_dataRemoteData[]

routing_numberString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

employeeString

remote_dataRemoteData[]

routing_numberString

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

employeeString

remote_created_atString

remote_idString

routing_numberString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_created_atString

remote_dataRemoteData[]

remote_idString

routing_numberString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString
ADP Workforce Now

ADP Workforce Now

Coming Soon
AlexisHR

AlexisHR

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/bank-info/{id}

Returns a BankInfo object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


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

idString
Required

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

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

Response
JSON
{
"id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
"remote_id": "123234",
"employee": "a3617eb4-dfe3-426f-921e-a65fc1661e10",
"account_number": "439291590",
"routing_number": "089690059",
"bank_name": "Chase",
"account_type": "CHECKING",
"remote_created_at": "2021-12-06T10:11:26Z",
"remote_data": [
{
"path": "/bank-info",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
Field support by platform

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

remote_dataRemoteData[]

routing_numberString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_created_atString

remote_dataRemoteData[]

remote_idString

routing_numberString

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString

PayCaptain

PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

routing_numberString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

employeeString

remote_dataRemoteData[]

routing_numberString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

employeeString

remote_dataRemoteData[]

routing_numberString

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

employeeString

remote_created_atString

remote_idString

routing_numberString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_created_atString

remote_dataRemoteData[]

remote_idString

routing_numberString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_dataRemoteData[]

routing_numberString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


account_numberString

account_typeEnum

bank_nameString

employeeString

remote_dataRemoteData[]

remote_idString

routing_numberString
ADP Workforce Now

ADP Workforce Now

Coming Soon
AlexisHR

AlexisHR

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Overview

Next Up

Benefits