Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Update an account
Updates an existing account’s information. This endpoint allows you to update various account details during onboarding or after the account has been created.
curl --request PUT \
--url https://{environment}.straddle.io/v1/accounts/{account_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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": "<string>",
"phone": "<string>",
"url": "<string>"
}
},
"metadata": {},
"external_id": "<string>"
}'{
"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": "unknown",
"status": "unknown",
"status_detail": {
"reason": "unknown",
"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": "<string>",
"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"
}
}Authorizations
JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
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
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.
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.
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.
Response
Indicates the type of data 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').
unknown, business The current status of the account (e.g., 'active', 'inactive', 'pending').
unknown, created, onboarding, active, rejected, inactive unknown, unverified, in_review, pending, stuck, verified, failed_verification, disabled, terminated watchtower The access level granted to the account. This is determined by your platform configuration. Possible values: 'managed', 'standard'.
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.
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 active, inactive immediate, next_day, one_day, two_day, three_day, unknown immediate, next_day, one_day, two_day, three_day, unknown The datetime of when the terms of service were accepted, in ISO 8601 format.
The type or version of the agreement accepted. Possible values: 'embedded'.
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.
The URL where the full text of the accepted agreement can be found.
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.
Was this page helpful?
curl --request PUT \
--url https://{environment}.straddle.io/v1/accounts/{account_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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": "<string>",
"phone": "<string>",
"url": "<string>"
}
},
"metadata": {},
"external_id": "<string>"
}'{
"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": "unknown",
"status": "unknown",
"status_detail": {
"reason": "unknown",
"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": "<string>",
"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"
}
}