Sandbox
Create a new Sandbox Connection
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 Connection
Create a new connection (new company/provider pair) with a new account
POST
/
sandbox
/
connections
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });
console.log(connection.account_id);
}
main();
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"authentication_type": "credential",
"products": [
"<string>"
],
"access_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token_type": "<string>"
}
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 connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });
console.log(connection.account_id);
}
main();
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"authentication_type": "credential",
"products": [
"<string>"
],
"access_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token_type": "<string>"
}