Sandbox
Create a new sandbox account
Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Sandbox
Create a new sandbox account
Create a new account for an existing connection (company/provider pair)
POST
/
sandbox
/
connections
/
accounts
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const account = await client.sandbox.connections.accounts.create({
company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
provider_id: 'provider_id',
});
console.log(account.account_id);
}
main();
{
"connection_id": "a237a1c3-1a5e-44ae-a8fd-81f76fd715c2",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"provider_id": "gusto",
"authentication_type": "credential",
"products": [
"company"
],
"access_token": "7eb55bcf-6593-4040-afac-252ee1f78e20"
}
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const account = await client.sandbox.connections.accounts.create({
company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
provider_id: 'provider_id',
});
console.log(account.account_id);
}
main();
{
"connection_id": "a237a1c3-1a5e-44ae-a8fd-81f76fd715c2",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"provider_id": "gusto",
"authentication_type": "credential",
"products": [
"company"
],
"access_token": "7eb55bcf-6593-4040-afac-252ee1f78e20"
}