curl --request POST \
  --url https://sandbox.rollfi.xyz/adminPortal/addCompanyBankAccount \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addCompanyBankAccount",
  "companyFundingSourceEntity": {
    "companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
    "accountNumber": "9889890989",
    "routingNumber": "221982389",
    "bankName": "Chase Bank",
    "accountType": "savings",
    "accountName": "default"
  }
}
'

{
  "companyFundingSourceEntity": {
    "status": "pending",
    "message": "The Company's bank account has been added successfully."
  }
}

Admin Portal

addCompanyBankAccount

The addCompanyBankAccount API adds bank account details for a company to process payroll.

What it does:

Adds company bank account information including account number, routing number, and bank name
Sets up the funding source for payroll processing and payments

Note:

Account type is limited to savings or checking
This endpoint can also be used to update a company’s linked account after using deactivateCompanyBankAccount on the existing entity.

Account Linking with Plaid

Use the linkType field to determine the linking method for the account. Supported options are Manual, Plaid and CustomProvider. If not included, linkType defaults to Manual
If linkType is Plaid, you must choose between sending the link via email or returning the link via API to surface in your UI using the plaidOptions field. Account details are not required.
The invite email will be sent to the payrollAdmin. If you wish to send the invite to a different email address, please specify with ‘email’
The intiital valid link will be re-used for subsequent ‘addCompanyBankAccount’ calls

⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours.

POST

adminPortal

addCompanyBankAccount

curl --request POST \
  --url https://sandbox.rollfi.xyz/adminPortal/addCompanyBankAccount \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addCompanyBankAccount",
  "companyFundingSourceEntity": {
    "companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
    "accountNumber": "9889890989",
    "routingNumber": "221982389",
    "bankName": "Chase Bank",
    "accountType": "savings",
    "accountName": "default"
  }
}
'

{
  "companyFundingSourceEntity": {
    "status": "pending",
    "message": "The Company's bank account has been added successfully."
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

Example:

"addCompanyBankAccount"

companyFundingSourceEntity

object

required

Show child attributes

linkType

enum<string>

Default: Manual

Available options:

Plaid,

CustomProvider,

Manual

plaidOptions

enum<string>

Required if linkType: plaid

Available options:

generateURL,

sendInviteByEmail

Response

companyFundingSourceEntity

object

Show child attributes

message

string

invitesentto

string

plaidLinkURL

string

expirationDate

string

updateW4Information deactivateCompanyBankAccount