{ "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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rollfi","colors":{"primary":"#FF4217","light":"#FAFAFA","dark":"#0E0E0E"},"logo":{"light":"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba","dark":"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba"},"favicon":"https://mintcdn.com/rollfi/3cmcmZSTLqMTkR5Y/favicon.png?fit=max\u0026auto=format\u0026n=3cmcmZSTLqMTkR5Y\u0026q=85\u0026s=59ceef17edf39bfa875cf1c7c3f6d7d3","api":{"mdx":{"auth":{"method":"basic","name":"client_id:api_key"},"server":["https://sandbox.rollfi.xyz"]}},"navbar":{"links":[{"href":"https://cal.com/team/rollfi/embedded-payroll","label":"Contact Us"}],"primary":{"type":"button","label":"Sign in","href":"https://app.rollfi.xyz/app/Rollfi-Registration/Login"}},"footer":{"socials":{"twitter":"https://twitter.com/rollfi_xyz","linkedin":"https://www.linkedin.com/company/rollfi"}},"icons":{"library":"lucide"},"styling":{"latex":true},"navigation":{"global":{"tabs":[{"tab":"Embedded Payroll","href":"https://www.rollfi.xyz"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rollfi","hasAudioNarration":false,"actualSubdomain":"rollfi","customDomains":["developer.rollfi.xyz"],"gitSource":{"type":"github","owner":"rollfipayroll","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfd1f6369ee86f9f90cf6f","collectionId":"de0b6885-7a3b-4ba2-8d98-9b077dc12566","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfd1f6369ee86f9f90cf6f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfd1f6369ee86f9f90cf6f","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":354},{"language":"default","tag":"Reports","count":55},{"language":"default","tag":"Admin Portal","count":43},{"language":"default","tag":"Payroll","count":25},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Company Onboarding","count":11},{"language":"default","tag":"User Portal","count":10},{"language":"default","tag":"User Onboarding","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/adminportal/addCompanyBankAccount","slug":"/api-reference/adminportal/addCompanyBankAccount","pageMetadata":{"openapi":"post /adminPortal/addCompanyBankAccount","title":"addCompanyBankAccount","description":"The `addCompanyBankAccount` API adds bank account details for a company to process payroll.\n\n### What it does:\n- Adds company bank account information including account number, routing number, and bank name\n- Sets up the funding source for payroll processing and payments\n\n### Note:\n- Account type is limited to **savings** or **checking**\n- This endpoint can also be used to update a company's linked account after using `deactivateCompanyBankAccount` on the existing entity.\n\n### Account Linking with Plaid\n- 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\n- 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.\n- 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'\n- The intiital valid link will be re-used for subsequent 'addCompanyBankAccount' calls\n\n⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours. ","href":"/api-reference/adminportal/addCompanyBankAccount"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"addCompanyBankAccount\"\n }), \" API adds bank account details for a company to process payroll.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"What it does:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Adds company bank account information including account number, routing number, and bank name\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Sets up the funding source for payroll processing and payments\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Note:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Account type is limited to \", _jsx(_components.strong, {\n children: \"savings\"\n }), \" or \", _jsx(_components.strong, {\n children: \"checking\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"This endpoint can also be used to update a company’s linked account after using \", _jsx(_components.code, {\n children: \"deactivateCompanyBankAccount\"\n }), \" on the existing entity.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Account Linking with Plaid\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Use the \", _jsx(_components.code, {\n children: \"linkType\"\n }), \" field to determine the linking method for the account. Supported options are \", _jsx(_components.strong, {\n children: \"Manual\"\n }), \", \", _jsx(_components.strong, {\n children: \"Plaid\"\n }), \" and \", _jsx(_components.strong, {\n children: \"CustomProvider\"\n }), \". If not included, linkType defaults to Manual\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"If \", _jsx(_components.code, {\n children: \"linkType\"\n }), \" is \", _jsx(_components.strong, {\n children: \"Plaid\"\n }), \", you must choose between sending the link via email or returning the link via API to surface in your UI using the \", _jsx(_components.code, {\n children: \"plaidOptions\"\n }), \" field. Account details are not required.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"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’\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"The intiital valid link will be re-used for subsequent ‘addCompanyBankAccount’ calls\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /adminPortal/addCompanyBankAccount","title":"addCompanyBankAccount","description":"The `addCompanyBankAccount` API adds bank account details for a company to process payroll.\n\n### What it does:\n- Adds company bank account information including account number, routing number, and bank name\n- Sets up the funding source for payroll processing and payments\n\n### Note:\n- Account type is limited to **savings** or **checking**\n- This endpoint can also be used to update a company's linked account after using `deactivateCompanyBankAccount` on the existing entity.\n\n### Account Linking with Plaid\n- 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\n- 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.\n- 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'\n- The intiital valid link will be re-used for subsequent 'addCompanyBankAccount' calls\n\n⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours. ","href":"/api-reference/adminportal/addCompanyBankAccount"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"addCompanyBankAccount","deprecated":false,"description":"The `addCompanyBankAccount` API adds bank account details for a company to process payroll.\n\n### What it does:\n- Adds company bank account information including account number, routing number, and bank name\n- Sets up the funding source for payroll processing and payments\n\n### Note:\n- Account type is limited to **savings** or **checking**\n- This endpoint can also be used to update a company's linked account after using `deactivateCompanyBankAccount` on the existing entity.\n\n### Account Linking with Plaid\n- 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\n- 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.\n- 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'\n- The intiital valid link will be re-used for subsequent 'addCompanyBankAccount' calls\n\n⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours. ","tags":[],"parameters":[],"requestBody":"6c2c079d-38ea-4127-abec-17e7b2896b13","responses":{"200":"1e628239-bbbc-43ae-90cb-4f46dfd5f8b0","400":"94744825-053b-4be4-87df-2bba3457fec9"},"security":[],"method":"post","type":"path","servers":[],"path":"/adminPortal/addCompanyBankAccount","baseUrlOptions":["https://sandbox.rollfi.xyz"],"title":"addCompanyBankAccount","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","examples":["addCompanyBankAccount"],"title":"addCompanyBankAccount","isRequired":true,"uniqueKey":"method","typeLabel":"string"},"companyFundingSourceEntity":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"companyFundingSourceEntity.companyId","typeLabel":"string\u003cuuid>"},"accountNumber":{"type":"string","maxLength":40,"description":"Not required for Plaid","uniqueKey":"companyFundingSourceEntity.accountNumber","typeLabel":"string"},"routingNumber":{"type":"string","maxLength":40,"description":"Not required for Plaid","uniqueKey":"companyFundingSourceEntity.routingNumber","typeLabel":"string"},"bankName":{"type":"string","maxLength":40,"description":"Not required for Plaid","uniqueKey":"companyFundingSourceEntity.bankName","typeLabel":"string"},"accountType":{"type":"string","maxLength":40,"enum":["savings","checking"],"description":"Not required for Plaid","uniqueKey":"companyFundingSourceEntity.accountType","typeLabel":"enum\u003cstring>"},"accountName":{"type":"string","description":"Not required for Plaid","uniqueKey":"companyFundingSourceEntity.accountName","typeLabel":"string"}},"required":["companyId"],"isRequired":true,"uniqueKey":"companyFundingSourceEntity","typeLabel":"object"},"linkType":{"type":"string","enum":["Plaid","CustomProvider","Manual"],"description":"Default: Manual","uniqueKey":"linkType","typeLabel":"enum\u003cstring>"},"plaidOptions":{"type":"string","description":"Required if linkType: plaid","enum":["generateURL","sendInviteByEmail"],"uniqueKey":"plaidOptions","typeLabel":"enum\u003cstring>"}},"required":["method","companyFundingSourceEntity"],"uniqueKey":"","typeLabel":"object"},"examples":{"1":{"title":"1","value":{"method":"addCompanyBankAccount","companyFundingSourceEntity":{"companyId":"8A9B7683-8E02-494D-8422-963FD05EE785","accountNumber":"9889890989","routingNumber":"221982389","bankName":"Chase Bank","accountType":"savings","accountName":"default"}}},"2":{"title":"2","value":{"method":"addCompanyBankAccount","linkType":"Plaid","plaidOptions":"sendInviteByEmail","email":"test@mailsac.com","companyFundingSourceEntity":{"companyId":"03B5FD90-4A91-46D8-A892-CFB8F52A8E67"}}},"3":{"title":"3","value":{"method":"addCompanyBankAccount","linkType":"Plaid","plaidOptions":"generateURL","companyFundingSourceEntity":{"companyId":"03B5FD90-4A91-46D8-A892-CFB8F52A8E67"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"1e628239-bbbc-43ae-90cb-4f46dfd5f8b0":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"companyFundingSourceEntity":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"companyFundingSourceEntity.status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"companyFundingSourceEntity.message","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"companyFundingSourceEntity","typeLabel":"object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"invitesentto":{"type":"string","uniqueKey":"invitesentto","typeLabel":"string"},"plaidLinkURL":{"type":"string","uniqueKey":"plaidLinkURL","typeLabel":"string"},"expirationDate":{"type":"string","uniqueKey":"expirationDate","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"1":{"title":"1","value":{"companyFundingSourceEntity":{"status":"pending","message":"The Company's bank account has been added successfully."}}},"2":{"title":"2","value":{"message":"Bank Linking is in progress. The company will be updated once the linking is completed.","plaidLinkURL":"https://secure.plaid.com/hl/lsqr1nnr54r9so9751n0rn0o625q7p5r10","expirationDate":"2026-06-15T15:06:27.902391Z"}},"3":{"title":"3","value":{"message":"Bank Linking is in progress , payPercentage will be updated , once the linking is completed.","invitesentto":"testPlaid@mailsac.com","plaidLinkURL":"https://secure.plaid.com/hl/lsqr1nnr54r9so9751n0rn0o625q7p5r10","expirationDate":"2026-06-15T15:06:27.807Z"}}},"exampleType":"examples"}},"headers":{},"exampleType":"examples"},"94744825-053b-4be4-87df-2bba3457fec9":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"required":["code"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":400,"message":"Invalid CompanyId"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"message":"Invalid CompanyId"}}}},"exampleType":"examples"}},"headers":{},"exampleType":"examples"}},"security":{"2830e7f1-7183-4008-b0c1-eaf3dae5629a":{"Authorization":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"Rollfi_v2.openapi.json"},"subdomain":"rollfi","siteName":"Rollfi","title":"addCompanyBankAccount - Rollfi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-07T14:08:28.012Z","originalFileLocation":"api-reference/adminportal/addCompanyBankAccount.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\u0026#x27;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 \u0026#x27;email\u0026#x27; - The intiital valid link will be re-used for subsequent \u0026#x27;addCompanyBankAccount\u0026#x27; calls ⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rollfi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"addCompanyBankAccount - Rollfi\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\u0026#x27;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 \u0026#x27;email\u0026#x27; - The intiital valid link will be re-used for subsequent \u0026#x27;addCompanyBankAccount\u0026#x27; calls ⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rollfi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rollfi.mintlify.app/_mintlify/api/og/v2?division=Admin+Portal\u0026amp;title=addCompanyBankAccount\u0026amp;description=The+%60addCompanyBankAccount%60+API+adds+bank+account+details+for+a+company+to+process+payroll.%0A%0A%23%23%23+What+it+does%3A%0A-+Adds+company+bank+account+information+including\u0026amp;theme=b6b82f0d9dde7dd38e7329b6\u0026amp;signature=2c244157afcde579fa8c091031acf6407f5d0426fc281007c7f9a7256a5edad7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"addCompanyBankAccount - Rollfi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\u0026#x27;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 \u0026#x27;email\u0026#x27; - The intiital valid link will be re-used for subsequent \u0026#x27;addCompanyBankAccount\u0026#x27; calls ⚠️ Warning: Plaid links have an expiry and should be completed as soon as possible. Default expiry is 72 hours.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rollfi.mintlify.app/_mintlify/api/og/v2?division=Admin+Portal\u0026amp;title=addCompanyBankAccount\u0026amp;description=The+%60addCompanyBankAccount%60+API+adds+bank+account+details+for+a+company+to+process+payroll.%0A%0A%23%23%23+What+it+does%3A%0A-+Adds+company+bank+account+information+including\u0026amp;theme=b6b82f0d9dde7dd38e7329b6\u0026amp;signature=2c244157afcde579fa8c091031acf6407f5d0426fc281007c7f9a7256a5edad7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rollfi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4217\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/adminportal/addCompanyBankAccount.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.rollfi.xyz/#organization\",\"name\":\"Rollfi\",\"url\":\"https://developer.rollfi.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.rollfi.xyz#website\",\"name\":\"Rollfi\",\"url\":\"https://developer.rollfi.xyz\",\"publisher\":{\"@id\":\"https://developer.rollfi.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount#webpage\",\"url\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount\",\"name\":\"addCompanyBankAccount\",\"description\":\"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.\",\"dateModified\":\"2026-07-07T14:08:28.012Z\",\"isPartOf\":{\"@id\":\"https://developer.rollfi.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.rollfi.xyz/api-reference/companyonboarding/createBusiness\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Admin Portal\",\"item\":\"https://developer.rollfi.xyz/api-reference/adminportal/addUser\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"addCompanyBankAccount\",\"item\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount#apireference\",\"headline\":\"addCompanyBankAccount\",\"name\":\"addCompanyBankAccount\",\"description\":\"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.\",\"url\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount\",\"mainEntityOfPage\":{\"@id\":\"https://developer.rollfi.xyz/api-reference/adminportal/addCompanyBankAccount#webpage\"},\"dateModified\":\"2026-07-07T14:08:28.012Z\",\"publisher\":{\"@id\":\"https://developer.rollfi.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.rollfi.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rollfi\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rollfi","nav":{"global":{"tabs":[{"tab":"Embedded Payroll","href":"https://www.rollfi.xyz"}]},"anchors":[{"anchor":"Documentation","icon":"lightbulb","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Documentation","href":"/docs/PayrollAPIDocumentation"}]},{"anchor":"API Reference","icon":"terminal","groups":[{"group":"API Reference","pages":[{"group":"Company Onboarding","pages":[{"openapi":"post /companyOnboarding/createBusiness","title":"createBusiness","href":"/api-reference/companyonboarding/createBusiness"},{"openapi":"post /companyOnboarding/companyRegistration","title":"companyRegistration","href":"/api-reference/companyonboarding/companyRegistration"},{"openapi":"put /companyOnboarding/updateAdminUser","title":"updateAdminUser","href":"/api-reference/companyonboarding/updateAdminUser"},{"openapi":"post /companyOnboarding/addCompanyLocation","title":"addCompanyLocation","href":"/api-reference/companyonboarding/addcompanylocation"},{"openapi":"post /companyOnboarding/addKybInformation","title":"addKybInformation","href":"/api-reference/companyonboarding/addkybinformation"},{"openapi":"post /companyOnboarding/initiateCompanyKyb","title":"initiateCompanyKyb","href":"/api-reference/companyonboarding/initiateCompanyKyb"},{"openapi":"post /companyOnboarding/addBusinessUser","title":"addBusinessUser","href":"/api-reference/companyonboarding/addbusinessuser"},{"openapi":"post /companyOnboarding/addBookKeeper","title":"addBookKeeper","href":"/api-reference/companyonboarding/addBookKeeper"},{"openapi":"put /companyOnboarding/updateKybInformation","title":"updateKybInformation","href":"/api-reference/companyonboarding/updateKybInformation"},{"openapi":"delete /companyOnboarding/deleteBusinessUser","title":"deleteBusinessUser","href":"/api-reference/companyonboarding/deleteBusinessUser"},{"openapi":"put /companyOnboarding/updateCompany","title":"updateCompany","href":"/api-reference/companyonboarding/updateCompany"}]},{"group":"User Onboarding","pages":[{"openapi":"post /userOnboarding/addKycInformation","title":"addKycInformation","href":"/api-reference/useronboarding/addKycInformation"},{"openapi":"post /userOnboarding/addW4Information","title":"addW4Information","href":"/api-reference/useronboarding/addW4Information"},{"openapi":"put /userOnboarding/acceptTermsAndCondition","title":"acceptTermsAndCondition","href":"/api-reference/useronboarding/acceptTermsAndCondition"},{"openapi":"post /userOnboarding/initiateUserKyc","title":"initiateUserKyc","href":"/api-reference/useronboarding/initiateUserKyc"},{"openapi":"put /userOnboarding/updateKycInformation","title":"updateKycInformation","href":"/api-reference/useronboarding/updateKycInformation"},{"openapi":"post /userOnboarding/addStateW4Information","title":"addStateW4Information","href":"/api-reference/useronboarding/addStateW4Information"},{"openapi":"put /userOnboarding/updateStateW4Information","title":"updateStateW4Information","href":"/api-reference/useronboarding/updateStateW4Information"},{"openapi":"put /userOnboarding/updateW4Information","title":"updateW4Information","href":"/api-reference/useronboarding/updateW4Information"}]},{"group":"Admin Portal","pages":[{"openapi":"post /adminPortal/addUser","title":"addUser","href":"/api-reference/adminportal/addUser"},{"openapi":"post /adminPortal/addUsers","title":"addUsers","href":"/api-reference/adminportal/addUsers"},{"openapi":"put /adminPortal/updateUser","title":"updateUser","href":"/api-reference/adminportal/updateUser"},{"openapi":"delete /adminPortal/deleteUser","title":"deleteUser","href":"/api-reference/adminportal/deleteUser"},{"openapi":"post /adminPortal/addFormerUser","title":"addFormerUser","href":"/api-reference/adminportal/addFormerUser"},{"openapi":"post /adminPortal/addUserWage","title":"addUserWage","href":"/api-reference/adminportal/addUserWage"},{"openapi":"put /adminPortal/updateUserWage","title":"updateUserWage","href":"/api-reference/adminportal/updateUserWage"},{"openapi":"post /adminPortal/activateUser","title":"activateUser","href":"/api-reference/adminportal/activateUser"},{"openapi":"post /adminPortal/deactivateUser","title":"deactivateUser","description":"\nThe `deactivateUser` API temporarily deactivates an employee or contractor.\n\n### What it does:\n\n- Deactivates users while preserving their records for potential reactivation\n- Sets exit date and final paycheck details for the deactivated user\n- Triggers an automated email explaining the deactivation to the employee\n- Allows additional notes to be recorded - circumstances or employee specific details on deactivation\n\n### Notes:\n\n- Different from `terminateUser` - deactivated users can be reactivated with `activateUser`\n- Used for temporary separations like leave of absence or seasonal layoffs","href":"/api-reference/adminportal/deactivateUser"},{"openapi":"post /adminPortal/addCompanyBankAccount","title":"addCompanyBankAccount","href":"/api-reference/adminportal/addCompanyBankAccount"},{"openapi":"put /adminPortal/deactivateCompanyBankAccount","title":"deactivateCompanyBankAccount","description":"\nThe `deactivateCompanyBankAccount` API deactivates a company's bank account in the system.\n\n### What it does:\n\n- Deactivates the company's funding source while preserving account records\n- Prevents future payroll transactions from using the deactivated account\n\n### Notes:\n\n- At least one active bank account must be linked to a company at all times\n- Historical banking history is maintained for compliance\n- Deactivated bank accounts cannot be re-activated they must be manually added again using `addCompanyBankAccount`","href":"/api-reference/adminportal/deactivateCompanyBankAccount"},{"openapi":"post /adminPortal/verifyMicroDeposits","title":"verifyMicroDeposits","href":"/api-reference/adminportal/verifyMicroDeposits"},{"openapi":"post /adminPortal/addBusinessContractor","title":"addBusinessContractor","href":"/api-reference/adminportal/addBusinessContractor"},{"openapi":"post /adminPortal/addStateRegistrationInfo","title":"addStateRegistrationInfo","href":"/api-reference/adminportal/addStateRegistrationInfo"},{"openapi":"put /adminPortal/updateStateRegistrationInfo","title":"updateStateRegistrationInfo","href":"/api-reference/adminportal/updateStateRegistrationInfo"},{"openapi":"post /adminPortal/addTimeOffPolicy","title":"addTimeOffPolicy","href":"/api-reference/adminportal/addTimeOffPolicy"},{"openapi":"post /adminPortal/addTimeOffPolicyAssignment","title":"addTimeOffPolicyAssignment","href":"/api-reference/adminportal/addTimeOffPolicyAssignment"},{"openapi":"put /adminPortal/updateTimeOffPolicyAssignment","title":null,"href":"/api-reference/adminportal/updateTimeOffPolicyAssignment"},{"openapi":"post /adminPortal/approveTimeOffRequest","title":"approveTimeOffRequest","href":"/api-reference/adminportal/approveTimeOffRequest"},{"openapi":"post /adminPortal/addTimeTrackingPolicy","title":"addTimeTrackingPolicy","href":"/api-reference/adminportal/addTimeTrackingPolicy"},{"openapi":"put /adminPortal/updateTimeTrackingPolicy","title":"updateTimeTrackingPolicy","href":"/api-reference/adminportal/updateTimeTrackingPolicy"},{"openapi":"delete /adminPortal/deleteTimeTrackingPolicy","title":"deleteTimeTrackingPolicy","href":"/api-reference/adminportal/deleteTimeTrackingPolicy"},{"openapi":"post /adminPortal/addTimeTrackingPolicyAssignments","title":"addTimeTrackingPolicyAssignments","href":"/api-reference/adminportal/addTimeTrackingPolicyAssignments"},{"openapi":"post /adminPortal/removeTimeTrackingPolicyAssignments","title":"removeTimeTrackingPolicyAssignments","href":"/api-reference/adminportal/removeTimeTrackingPolicyAssignments"},{"openapi":"post /adminPortal/upsertTimeEntry","title":"upsertTimeEntry","href":"/api-reference/adminportal/upsertTimeEntry"},{"openapi":"delete /adminPortal/deleteTimeEntry","title":"deleteTimeEntry","href":"/api-reference/adminportal/deleteTimeEntry"},{"openapi":"put /adminPortal/updateTimeCardApprovals","title":"updateTimeCardApprovals","href":"/api-reference/adminportal/updateTimeCardApprovals"},{"openapi":"post /adminPortal/syncTimeCardsToPayroll","title":"syncTimeCardsToPayroll","href":"/api-reference/adminportal/syncTimeCardsToPayroll"},{"openapi":"put /adminPortal/updateBusinessUserAsEmployee","title":"updateBusinessUserAsEmployee","href":"/api-reference/adminportal/updateBusinessUserAsEmployee"},{"openapi":"put /adminPortal/updateEmployeeAsBusinessUser","title":"updateEmployeeAsBusinessUser","href":"/api-reference/adminportal/updateEmployeeAsBusinessUser"},{"openapi":"put /adminPortal/updateBusinessUser","title":"updateBusinessUser","href":"/api-reference/adminportal/updateBusinessUser"},{"openapi":"put /adminPortal/updateCompanyLocation","title":"updateCompanyLocation","href":"/api-reference/adminportal/updateCompanyLocation"},{"openapi":"delete /adminPortal/deleteStateRegistrationInfo","title":"deleteStateRegistrationInfo","href":"/api-reference/adminportal/deleteStateRegistrationInfo"},{"openapi":"post /adminPortal/addEmployeeMiscellaneousStateTax","title":"addEmployeeMiscellaneousStateTax","href":"/api-reference/adminportal/addEmployeeMiscellaneousStateTax"},{"openapi":"put /adminPortal/terminateUser","title":"terminateUser","href":"/api-reference/adminportal/terminateUser"},{"openapi":"post /adminPortal/uploadDocument","title":"uploadDocument","href":"/api-reference/adminportal/uploadDocument"},{"openapi":"get /adminPortal/downloadDocument","title":"downloadDocument","href":"/api-reference/adminportal/downloadDocument"},{"openapi":"post /adminPortal/addRecurringPayItem","title":"addRecurringPayItem","href":"/api-reference/adminportal/addRecurringPayItem"},{"openapi":"put /adminPortal/updateRecurringPayItem","title":"updateRecurringPayItem","href":"/api-reference/adminportal/updateRecurringPayItem"},{"openapi":"delete /adminPortal/deleteRecurringPayItem","title":"deleteRecurringPayItem","href":"/api-reference/adminportal/deleteRecurringPayItem"},{"openapi":"post /adminPortal/addGarnishments","title":"addGarnishments","href":"/api-reference/adminportal/addGarnishments"},{"openapi":"put /adminPortal/updateGarnishment","title":"updateGarnishment","href":"/api-reference/adminportal/updateGarnishment"},{"openapi":"post /adminPortal/removeGarnishment","title":"removeGarnishment","href":"/api-reference/adminportal/removeGarnishment"}]},{"group":"User Portal","pages":[{"openapi":"post /userPortal/addUserBankAccount","title":"addUserBankAccount","href":"/api-reference/userportal/addUserBankAccount"},{"openapi":"put /userPortal/updateUserPayPercentage","title":"updateUserPayPercentage","href":"/api-reference/userportal/updateUserPayPercentage"},{"openapi":"put /userPortal/updateKycInformation","title":"updateKycInformation","href":"/api-reference/userportal/updateKycInformation"},{"openapi":"post /userPortal/addTimeOffRequest","title":"addTimeOffRequest","href":"/api-reference/userportal/addTimeOffRequest"},{"openapi":"post /userPortal/cancelTimeOffRequest","title":"cancelTimeOffRequest","href":"/api-reference/userportal/cancelTimeOffRequest"},{"openapi":"delete /userPortal/deleteTimeOffRequest","title":"deleteTimeOffRequest","href":"/api-reference/userportal/deleteTimeOffRequest"},{"openapi":"post /userPortal/clockIn","title":"clockIn","href":"/api-reference/userportal/clockIn"},{"openapi":"put /userPortal/clockOut","title":"clockOut","href":"/api-reference/userportal/clockOut"},{"openapi":"post /userPortal/startBreak","title":"startBreak","href":"/api-reference/userportal/startBreak"},{"openapi":"put /userPortal/endBreak","title":"endBreak","href":"/api-reference/userportal/endBreak"}]},{"group":"Payroll","pages":[{"openapi":"post /payroll/addPaySchedule","title":"addPaySchedule","href":"/api-reference/payroll/addPaySchedule"},{"openapi":"put /payroll/updatePaySchedule","title":"updatePaySchedule","href":"/api-reference/payroll/updatePaySchedule"},{"openapi":"post /payroll/deactivatePaySchedule","title":"deactivatePaySchedule","href":"/api-reference/payroll/deactivatePaySchedule"},{"openapi":"post /payroll/importRegularDifferentialPayrollData","title":"importRegularDifferentialPayrollData","href":"/api-reference/payroll/importRegularDifferentialPayrollData"},{"openapi":"post /payroll/importRegularPayrollData","title":"importRegularPayrollData","href":"/api-reference/payroll/importRegularPayrollData"},{"openapi":"post /payroll/addSupplementalPayPeriod","title":"addSupplementalPayPeriod","href":"/api-reference/payroll/addSupplementalPayPeriod"},{"openapi":"post /payroll/initiatePayroll","title":"initiatePayroll","href":"/api-reference/payroll/initiatePayroll"},{"openapi":"post /payroll/removeDeductions","title":"removeDeductions","href":"/api-reference/payroll/removeDeductions"},{"openapi":"post /payroll/removeAdditionalCompensations","title":"removeAdditionalCompensations","href":"/api-reference/payroll/removeAdditionalCompensations"},{"openapi":"post /payroll/removeReimbursements","title":"removeReimbursements","href":"/api-reference/payroll/removeReimbursements"},{"openapi":"post /payroll/removeUsersFromSupplementalPayPeriod","title":"removeUsersFromSupplementalPayPeriod","href":"/api-reference/payroll/removeUsersFromSupplementalPayPeriod"},{"openapi":"post /payroll/addUsersToSupplementalPayPeriod","title":"addUsersToSupplementalPayPeriod","href":"/api-reference/payroll/addUsersToSupplementalPayPeriod"},{"openapi":"put /payroll/editUsersOfSupplementalPayPeriod","title":"editUsersOfSupplementalPayPeriod","href":"/api-reference/payroll/editUsersOfSupplementalPayPeriod"},{"openapi":"post /payroll/addUsersToRegularPayPeriod","title":"addUsersToRegularPayPeriod","href":"/api-reference/payroll/addUsersToRegularPayPeriod"},{"openapi":"post /payroll/removeUsersFromRegularPayPeriod","title":"removeUsersFromRegularPayPeriod","href":"/api-reference/payroll/removeUsersFromRegularPayPeriod"},{"openapi":"post /payroll/removeOvertime","title":"removeOvertime","href":"/api-reference/payroll/removeOvertime"},{"openapi":"post /payroll/skipPayPeriod","title":"skipPayPeriod","href":"/api-reference/payroll/skipPayPeriod"},{"openapi":"post /payroll/addSupplementalPayPeriodWithLineItems","title":"addSupplementalPayPeriodWithLineItems","href":"/api-reference/payroll/addSupplementalPayPeriodWithLineItems"},{"openapi":"post /payroll/cancelPayrollSubmission","title":"cancelPayrollSubmission","href":"/api-reference/payroll/cancelPayrollSubmission"},{"openapi":"post /payroll/importPayrollHistory","title":"importPayrollHistory","href":"/api-reference/payroll/importPayrollHistory"},{"openapi":"post /payroll/addPayrollTaxExemption","title":"addPayrollTaxExemption","href":"/api-reference/payroll/addPayrollTaxExemption"},{"openapi":"put /payroll/updatePayrollTaxExemption","title":"updatePayrollTaxExemption","href":"/api-reference/payroll/updatePayrollTaxExemption"},{"openapi":"post /payroll/addPayrollLineItemTaxAdjustments","title":"addPayrollLineItemTaxAdjustments","href":"/api-reference/payroll/addPayrollLineItemTaxAdjustments"},{"openapi":"put /payroll/updatePayrollLineItemTaxAdjustment","title":"updatePayrollLineItemTaxAdjustment","href":"/api-reference/payroll/updatePayrollLineItemTaxAdjustment"},{"openapi":"post /payroll/removePayrollLineItemTaxAdjustment","title":"removePayrollLineItemTaxAdjustment","href":"/api-reference/payroll/removePayrollLineItemTaxAdjustment"}]},{"group":"Benefits","pages":[{"openapi":"post /benefits/addEmployeeBenefits","title":"addEmployeeBenefits","href":"/api-reference/benefits/addEmployeeBenefits"},{"openapi":"put /benefits/updateEmployeeBenefits","title":"updateEmployeeBenefits","href":"/api-reference/benefits/updateEmployeeBenefits"},{"openapi":"post /benefits/addCompanyEmployeeBenefits","title":"addCompanyEmployeeBenefits","href":"/api-reference/benefits/addCompanyEmployeeBenefits"},{"openapi":"post /benefits/removeCompanyBenefits","title":"removeCompanyBenefits","href":"/api-reference/benefits/removeCompanyBenefits"},{"openapi":"post /benefits/removeEmployeeBenefits","title":"removeEmployeeBenefits","href":"/api-reference/benefits/removeEmployeeBenefits"},{"openapi":"post /benefits/addCompanyBenefits","title":"addCompanyBenefits","href":"/api-reference/benefits/addCompanyBenefits"},{"openapi":"get /benefits/getBenefitValidEffectiveMonths","title":"getBenefitValidEffectiveMonths","href":"/api-reference/benefits/getBenefitValidEffectiveMonths"}]},{"group":"Reports","pages":[{"group":"PTO","pages":[{"openapi":"get /reports/getTimeOffPolicyTypes","title":"getTimeOffPolicyTypes","href":"/api-reference/reports/PaidTimeOff/getTimeOffPolicyTypes"},{"openapi":"get /reports/getTimeOffPolicyAssignments","title":"getTimeOffPolicyAssignments","href":"/api-reference/reports/PaidTimeOff/getTimeOffPolicyAssignments"},{"openapi":"get /reports/getTimeOffRequest","title":"getTimeOffRequest","href":"/api-reference/reports/PaidTimeOff/getTimeOffRequest"}]},{"group":"Time Tracking","pages":[{"openapi":"get /reports/getEmployeeTimeTrackingStatus","title":"getEmployeeTimeTrackingStatus","href":"/api-reference/reports/TimeTracking/getEmployeeTimeTrackingStatus"},{"openapi":"get /reports/getTimeTrackingPolicy","title":"getTimeTrackingPolicy","href":"/api-reference/reports/TimeTracking/getTimeTrackingPolicy"},{"openapi":"get /reports/getPayPeriodTimeCards","title":"getPayPeriodTimeCards","href":"/api-reference/reports/TimeTracking/getPayPeriodTimeCards"},{"openapi":"get /reports/getEmployeePayPeriodTimeCard","title":"getEmployeePayPeriodTimeCard","href":"/api-reference/reports/TimeTracking/getEmployeePayPeriodTimeCard"}]},{"group":"Garnishments","pages":[{"openapi":"get /reports/getGarnishmentTypes","title":"getGarnishmentTypes","href":"/api-reference/reports/Garnishments/getGarnishmentTypes"},{"openapi":"get /reports/getGarnishmentAgencies","title":"getGarnishmentAgencies","href":"/api-reference/reports/Garnishments/getGarnishmentAgencies"},{"openapi":"get /reports/getGarnishmentFormFields","title":"getGarnishmentFormFields","href":"/api-reference/reports/Garnishments/getGarnishmentFormFields"}]},{"openapi":"get /reports/getActiveUsers","title":"getActiveUsers","href":"/api-reference/reports/getActiveUsers"},{"openapi":"get /reports/getAdditionalCompensationDescription","title":"getAdditionalCompensationDescription","href":"/api-reference/reports/getAdditionalCompensationDescription"},{"openapi":"get /reports/getBusinessUsers","title":"getBusinessUsers","href":"/api-reference/reports/getBusinessUsers"},{"openapi":"get /reports/getBusinessUserDetails","title":"getBusinessUserDetails","href":"/api-reference/reports/getBusinessUserDetails"},{"openapi":"get /reports/getCompanies","title":"getCompanies","href":"/api-reference/reports/getCompanies"},{"openapi":"get /reports/getCompanyInfo","title":"getCompanyInfo","href":"/api-reference/reports/getCompanyInfo"},{"openapi":"get /reports/getCompanyTask","title":"getCompanyTask","href":"/api-reference/reports/getCompanyTask"},{"openapi":"get /reports/getCompanyLocationInfo","title":"getCompanyLocationInfo","href":"/api-reference/reports/getCompanyLocationInfo"},{"openapi":"get /reports/getDeactivatedUsers","title":"getDeactivatedUsers","href":"/api-reference/reports/getDeactivatedUsers"},{"openapi":"get /reports/getDeductionDescription","title":"getDeductionDescription","href":"/api-reference/reports/getDeductionDescription"},{"openapi":"get /reports/getIndividualPayrollHistory","title":"getIndividualPayrollHistory","href":"/api-reference/reports/getIndividualPayrollHistory"},{"openapi":"get /reports/getOverTimeTypes","title":"getOverTimeTypes","href":"/api-reference/reports/getOverTimeTypes"},{"openapi":"get /reports/getProcessedPayperiodsDetails","title":"getProcessedPayperiodsDetails","href":"/api-reference/reports/getProcessedPayperiodsDetails"},{"openapi":"get /reports/getPaidEmployeesCountBasedOnDateRange","title":"getPaidEmployeesCountBasedOnDateRange","href":"/api-reference/reports/getPaidEmployeesCountBasedOnDateRange"},{"openapi":"get /reports/getPayPeriodDetails","title":"getPayPeriodDetails","href":"/api-reference/reports/getPayPeriodDetails"},{"openapi":"get /reports/getPayPeriod","title":"getPayPeriod","href":"/api-reference/reports/getPayPeriod"},{"openapi":"get /reports/getAllPayPeriods","title":"getAllPayPeriods","href":"/api-reference/reports/getAllPayPeriods"},{"openapi":"get /reports/getPayrollHistoryBasedOnPayPeriod","title":"getPayrollHistoryBasedOnPayPeriod","href":"/api-reference/reports/getPayrollHistoryBasedOnPayPeriod"},{"openapi":"get /reports/getPayrollHistoryBasedOnDateRange","title":"getPayrollHistoryBasedOnDateRange","href":"/api-reference/reports/getPayrollHistoryBasedOnDateRange"},{"openapi":"get /reports/getPayRun","title":"getPayRun","href":"/api-reference/reports/getPayRun"},{"openapi":"get /reports/getPaySchedule","title":"getPaySchedule","href":"/api-reference/reports/getPaySchedule"},{"openapi":"get /reports/getMonthlyAndSemiMonthlyPayScheduleDates","title":"getMonthlyAndSemiMonthlyPayScheduleDates","href":"/api-reference/reports/getMonthlyAndSemiMonthlyPayScheduleDates"},{"openapi":"get /reports/getPayStub","title":"getPayStub","href":"/api-reference/reports/getPayStub"},{"openapi":"get /reports/getPayBeginDates","title":"getPayBeginDates","href":"/api-reference/reports/getPayBeginDates"},{"openapi":"get /reports/getStateRegistrationFields","title":"getStateRegistrationFields","href":"/api-reference/reports/getStateRegistrationFields"},{"openapi":"get /reports/getStateW4FormFields","title":"getStateW4FormFields","href":"/api-reference/reports/getStateW4FormFields"},{"openapi":"get /reports/getTerminatedUsers","title":"getTerminatedUsers","href":"/api-reference/reports/getTerminatedUsers"},{"openapi":"get /reports/getTransactionBasedOnReference","title":"getTransactionBasedOnReference","href":"/api-reference/reports/getTransactionBasedOnReference"},{"openapi":"get /reports/getTransactions","title":"getTransactions","href":"/api-reference/reports/getTransactions"},{"openapi":"get /reports/getTransactionsBasedOnName","title":"getTransactionsBasedOnName","href":"/api-reference/reports/getTransactionsBasedOnName"},{"openapi":"get /reports/getUserTask","title":"getUserTask","href":"/api-reference/reports/getUserTask"},{"openapi":"get /reports/getCompanyBenefits","title":"getCompanyBenefits","href":"/api-reference/reports/getCompanyBenefits"},{"openapi":"get /reports/getUsersByCompanyName","title":"getUsersByCompanyName","href":"/api-reference/reports/getUsersByCompanyName"},{"openapi":"get /reports/getUnProcessedPayPeriod","title":"getUnProcessedPayPeriod","href":"/api-reference/reports/getUnProcessedPayPeriod"},{"openapi":"get /reports/getUsers","title":"getUsers","href":"/api-reference/reports/getUsers"},{"openapi":"get /reports/getUser","title":"getUser","href":"/api-reference/reports/getUser"},{"openapi":"get /reports/getEmployeeMiscellaneousStateTaxforPayroll","title":"getEmployeeMiscellaneousStateTaxforPayroll","href":"/api-reference/reports/getEmployeeMiscellaneousStateTaxforPayroll"},{"openapi":"get /reports/getEmployeeMiscellaneousStateTaxFormFields","title":"getEmployeeMiscellaneousStateTaxFormFields","href":"/api-reference/reports/getEmployeeMiscellaneousStateTaxFormFields"},{"openapi":"get /reports/getTaxNameForExemption","title":"getTaxNameForExemption","href":"/api-reference/reports/getTaxNameForExemption"},{"openapi":"get /reports/getCompanyTaxExemptions","title":"getCompanyTaxExemptions","href":"/api-reference/reports/getCompanyTaxExemptions"},{"openapi":"get /reports/getEmployeeTaxExemptions","title":"getEmployeeTaxExemptions","href":"/api-reference/reports/getEmployeeTaxExemptions"},{"openapi":"get /reports/getAllowedTaxAdjustmentsList","title":"getAllowedTaxAdjustmentsList","href":"/api-reference/reports/getAllowedTaxAdjustmentsList"},{"openapi":"get /reports/getUploadedDocuments","title":"getUploadedDocuments","href":"/api-reference/reports/getUploadedDocuments"},{"openapi":"get /reports/getPayrollJournalReport","title":"getPayrollJournalReport","href":"/api-reference/reports/getPayrollJournalReport"},{"openapi":"get /reports/getCashRequirementsReport","title":"getCashRequirementsReport","href":"/api-reference/reports/getCashRequirementsReport"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks/getWebhookPublicKey","title":"getWebhookPublicKey","href":"/api-reference/webhooks/getWebhookPublicKey"},{"group":"Company","pages":[{"title":"Company Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/Company/overview"},{"title":"Company KYB Status","openapi":"webhook companyKybStatus","href":"/api-reference/webhooks/Company/companyKybStatus"}]},{"group":"Employee","pages":[{"title":"Employee Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/Employee/overview"},{"title":"Employee Status","openapi":"webhook employeeStatus","href":"/api-reference/webhooks/Employee/employeeStatus"},{"title":"Employee KYC Status","openapi":"webhook employeeKycStatus","href":"/api-reference/webhooks/Employee/employeeKycStatus"}]},{"group":"Bank Account","pages":[{"title":"Bank Account Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/BankAccount/overview"},{"title":"Company Bank Account Status","openapi":"webhook companyBankAccountStatus","href":"/api-reference/webhooks/BankAccount/companyBankAccountStatus"},{"title":"Employee Bank Account Status","openapi":"webhook employeeBankAccountStatus","href":"/api-reference/webhooks/BankAccount/employeeBankAccountStatus"}]},{"group":"Pay Period","pages":[{"title":"Pay Period Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/PayPeriod/overview"},{"title":"Pay Period Status","openapi":"webhook payPeriodStatus","href":"/api-reference/webhooks/PayPeriod/payPeriodStatus"}]},{"group":"Pay Schedule","pages":[{"title":"Pay Schedule Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/PaySchedule/overview"},{"title":"Pay Schedule Status","openapi":"webhook payScheduleIsActive","href":"/api-reference/webhooks/PaySchedule/payScheduleStatus"}]}]},{"group":"Sandbox","pages":[{"openapi":"POST /sandbox/refreshCompanyKybStatus","title":"refreshCompanyKybStatus","href":"/api-reference/sandbox/refreshCompanyKybStatus"},{"openapi":"POST /sandbox/refreshUserKycStatus","title":"refreshUserKycStatus","href":"/api-reference/sandbox/refreshUserKycStatus"},{"openapi":"POST /sandbox/refreshCompanyBankAccountStatus","title":"refreshCompanyBankAccountStatus","href":"/api-reference/sandbox/refreshCompanyBankAccountStatus"},{"openapi":"POST /sandbox/refreshUserBankAccountStatus","title":"refreshUserBankAccountStatus","href":"/api-reference/sandbox/refreshUserBankAccountStatus"},{"openapi":"POST /sandbox/addFundsToLedger","title":"addFundsToLedger","href":"/api-reference/sandbox/addFundsToLedger"}]}]}]},{"anchor":"Terminology","icon":"book-open-text","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Terminology","href":"/terminology"}]},{"anchor":"Releases","icon":"notebook-pen","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Releases","href":"/releases/release-notes/Sept-2026"}]}]},"basePath":"","title":"addCompanyBankAccount - Rollfi","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}