Fundamentals
Customers
Charges
Payouts
Payments
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Onboard an account
Initiates the onboarding process for a new account. This endpoint can only be used for accounts where at least one representative and one linked bank account have already been created.
import Straddle from '@straddleio/straddle';
const client = new Straddle({
apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});
async function main() {
const accountV1 = await client.embed.accounts.onboard('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
terms_of_service: { accepted_date: '2019-12-27T18:11:19.117Z', agreement_type: 'embedded' },
});
console.log(accountV1.data);
}
main();{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "business",
"status": "created",
"status_detail": {
"reason": "unverified",
"source": "watchtower",
"code": "<string>",
"message": "<string>"
},
"business_profile": {
"name": "<string>",
"website": "<string>",
"legal_name": "<string>",
"description": "<string>",
"use_case": "<string>",
"tax_id": "<string>",
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"industry": {
"mcc": "<string>",
"sector": "<string>",
"category": "<string>"
},
"support_channels": {
"email": "jsmith@example.com",
"phone": "<string>",
"url": "<string>"
}
},
"capabilities": {
"payment_types": {
"charges": {
"capability_status": "active"
},
"payouts": {
"capability_status": "active"
}
},
"customer_types": {
"individuals": {
"capability_status": "active"
},
"businesses": {
"capability_status": "active"
}
},
"consent_types": {
"signed_agreement": {
"capability_status": "active"
},
"internet": {
"capability_status": "active"
}
}
},
"settings": {
"charges": {
"max_amount": 123,
"monthly_amount": 123,
"daily_amount": 123,
"monthly_count": 123,
"funding_time": "immediate",
"linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payouts": {
"max_amount": 123,
"monthly_amount": 123,
"daily_amount": 123,
"monthly_count": 123,
"funding_time": "immediate",
"linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"terms_of_service": {
"accepted_date": "2023-11-07T05:31:56Z",
"accepted_ip": "<string>",
"accepted_user_agent": "<string>",
"agreement_url": "<string>",
"agreement_type": "embedded"
},
"metadata": {},
"access_level": "standard",
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Prior to onboarding via this endpoint you must capture consent to the Straddle Payment Services Agreement (legal.straddle.io)
Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
Headers
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Body
Object containing details regarding the acceptance of the Terms of Service.
The datetime of when the terms of service were accepted, in ISO 8601 format.
The URL where the full text of the accepted agreement can be found.
The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.
embedded, direct The IP address from which the terms of service were accepted.
The user agent string of the browser or application used to accept the terms.
Response
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
object, array, error, none Unique identifier for the account.
The unique identifier of the organization this account belongs to.
The type of account (e.g., 'individual', 'business').
business The current status of the account (e.g., 'active', 'inactive', 'pending').
created, onboarding, active, rejected, inactive A machine-readable identifier for the specific status, useful for programmatic handling.
unverified, in_review, pending, stuck, verified, failed_verification, disabled, terminated, new Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.
watchtower A machine-readable code for the specific status, useful for programmatic handling.
A human-readable message describing the current status.
The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.
standard, managed The operating or trade name of the business.
URL of the business's primary marketing website.
The official registered name of the business.
A brief description of the business and its products or services.
A description of how the business intends to use Straddle's services.
The business's tax identification number (e.g., EIN in the US).
The primary contact phone number for the business.
The address object is optional. If provided, it must be a valid address.
Primary address line (e.g., street, PO Box).
Secondary address line (e.g., apartment, suite, unit, or building).
City, district, suburb, town, or village.
Two-letter state code.
Postal or ZIP code.
The country of the address, in ISO 3166-1 alpha-2 format.
The Merchant Category Code (MCC) that best describes the business. Optional.
The specific sector within the industry category. Required if not providing MCC.
The general category of the industry. Required if not providing MCC.
The email address for customer support inquiries.
The phone number for customer support.
The URL of the business's customer support page or contact form.
active, inactive active, inactive Whether the signed agreement payment authorization capability is enabled for the account.
active, inactive The maximum amount of a single charge.
The maximum dollar amount of charges in a calendar month.
The maximum dollar amount of charges in a calendar day.
The maximum number of charges in a calendar month.
The amount of time it takes for a charge to be funded. This value is defined by Straddle.
immediate, next_day, one_day, two_day, three_day The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.
The maximum amount of a single payout.
The maximum dollar amount of payouts in a month.
The maximum dollar amount of payouts in a day.
The maximum number of payouts in a month.
The amount of time it takes for a payout to be funded. This value is defined by Straddle.
immediate, next_day, one_day, two_day, three_day The unique identifier of the linked bank account to use for payouts.
The datetime of when the terms of service were accepted, in ISO 8601 format.
The URL where the full text of the accepted agreement can be found.
The type or version of the agreement accepted. Use embedded unless your platform was specifically enabled for direct agreements.
embedded, direct The IP address from which the terms of service were accepted.
The user agent string of the browser or application used to accept the terms.
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.
Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.
Timestamp of when the account was created.
Timestamp of the most recent update to the account.
import Straddle from '@straddleio/straddle';
const client = new Straddle({
apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});
async function main() {
const accountV1 = await client.embed.accounts.onboard('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
terms_of_service: { accepted_date: '2019-12-27T18:11:19.117Z', agreement_type: 'embedded' },
});
console.log(accountV1.data);
}
main();{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "business",
"status": "created",
"status_detail": {
"reason": "unverified",
"source": "watchtower",
"code": "<string>",
"message": "<string>"
},
"business_profile": {
"name": "<string>",
"website": "<string>",
"legal_name": "<string>",
"description": "<string>",
"use_case": "<string>",
"tax_id": "<string>",
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"industry": {
"mcc": "<string>",
"sector": "<string>",
"category": "<string>"
},
"support_channels": {
"email": "jsmith@example.com",
"phone": "<string>",
"url": "<string>"
}
},
"capabilities": {
"payment_types": {
"charges": {
"capability_status": "active"
},
"payouts": {
"capability_status": "active"
}
},
"customer_types": {
"individuals": {
"capability_status": "active"
},
"businesses": {
"capability_status": "active"
}
},
"consent_types": {
"signed_agreement": {
"capability_status": "active"
},
"internet": {
"capability_status": "active"
}
}
},
"settings": {
"charges": {
"max_amount": 123,
"monthly_amount": 123,
"daily_amount": 123,
"monthly_count": 123,
"funding_time": "immediate",
"linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payouts": {
"max_amount": 123,
"monthly_amount": 123,
"daily_amount": 123,
"monthly_count": 123,
"funding_time": "immediate",
"linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"terms_of_service": {
"accepted_date": "2023-11-07T05:31:56Z",
"accepted_ip": "<string>",
"accepted_user_agent": "<string>",
"agreement_url": "<string>",
"agreement_type": "embedded"
},
"metadata": {},
"access_level": "standard",
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}