Actions81
- Users Actions
- Organizations Actions
- Representatives Actions
- Bridge Actions
- Platforms Actions
- Tools Actions
- User Invites Actions
- Customers Actions
- Paykeys Actions
- Reports Actions
- Charge Actions
- Funding Events Actions
- Payments Actions
- Payout Actions
- Accounts Actions
- Get Account By Id
- put__v1_accounts_account_id
- Create Account
- get__v1_accounts
- post__v1_accounts_account_id_onboard
- post__v1_accounts_account_id_simulate
- patch__v1_internal_accounts_account_id
- get__v1_internal_accounts_account_id
- patch__v1_internal_accounts_account_id_status
- get__v1_internal_accounts_account_id_settings
- Capability Requests Actions
- Linked Bank Accounts Actions
Overview
This node operation updates the status of a specific account by sending a PATCH request to an internal API endpoint. It is useful in scenarios where you need to programmatically change the lifecycle state of an account, such as marking it as active, onboarding, rejected, or inactive. For example, after completing verification steps for a user account, you might use this node to update the account's status to "active" and provide additional details about the status.
Properties
| Name | Meaning |
|---|---|
| Account Id | The unique identifier of the account whose status you want to update. |
| Request Id | Optional client-generated identifier to trace and debug a single request (sent as HTTP header). |
| Correlation Id | Optional client-generated identifier to trace and debug a series of related requests (header). |
| Status | The new status of the account. Options: Unknown, Created, Onboarding, Active, Rejected, Inactive |
| Status Detail | Additional detail about the status. Options: Unknown, Unverified, In Review, Pending, Stuck, Verified, Failed Verification, Disabled, Terminated |
Output
The node outputs the JSON response from the API after updating the account status. This typically includes the updated account information reflecting the new status and status detail fields. The output does not include binary data.
Dependencies
- Requires an API key credential for authentication with the Straddle API.
- The base URL for the API is dynamically set based on the environment credential parameter.
- The node sends JSON requests and expects JSON responses.
- No other external dependencies are indicated.
Troubleshooting
- Common issues:
- Invalid or missing Account Id will cause the API call to fail.
- Providing invalid status or status detail values outside the allowed options may result in validation errors.
- Missing or incorrect API credentials will lead to authentication failures.
- Error messages:
- Authentication errors usually indicate problems with the API key or environment configuration.
- Validation errors from the API will specify which input property is invalid.
- Resolution tips:
- Ensure all required properties are provided and valid.
- Verify that the API key credential is correctly configured and has necessary permissions.
- Use the optional Request Id and Correlation Id headers to trace and debug requests in logs.
Links and References
- No direct links available from the source code.
- Refer to the Straddle API documentation for detailed information on account status management and possible status/status_detail values.