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 allows you to place a hold on a specific payout by its unique identifier. It is useful in scenarios where you need to temporarily suspend or review a payout before it is processed, for example, due to compliance checks, fraud prevention, or manual approval workflows.
Practical examples include:
- A financial platform wanting to pause a payout while verifying recipient details.
- An accounting system that holds payouts flagged for audit.
- A payment gateway integrating manual controls over automated disbursements.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the payout to place on hold. |
| Straddle Account Id | (Optional) For platforms: specifies an account ID to scope the request within a multi-tenant environment. |
| Request Id | (Optional) Client-generated identifier to trace and debug this specific request. |
| Correlation Id | (Optional) Client-generated identifier to trace and debug a series of related requests. |
| Reason | The reason for placing the payout on hold. |
Output
The node outputs JSON data representing the response from the API after placing the hold on the payout. This typically includes updated payout information such as status, timestamps, and any messages related to the hold action.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Straddle API.
- The node expects the base URL to be dynamically set based on the environment credential parameter.
- HTTP headers are set to accept and send JSON content.
- Optional custom headers can be sent for account scoping and request tracing.
Troubleshooting
- Missing or invalid payout Id: Ensure the "Id" property is provided and correctly references an existing payout.
- Authentication errors: Verify that the API key credential is valid and has permissions to modify payouts.
- Invalid or missing reason: The "Reason" field is required; omitting it may cause the API to reject the request.
- Header misconfiguration: If using optional headers like "Straddle Account Id", ensure they are correctly formatted and authorized.
- API endpoint unreachable: Confirm the environment value used to build the base URL is correct and the API service is accessible.
Common error messages will generally come from the API and indicate issues such as unauthorized access, invalid parameters, or resource not found. Reviewing the request Id and correlation Id in logs can help trace and debug these errors.
Links and References
- Straddle API Documentation (for detailed API usage and error codes)
- n8n documentation on HTTP Request Node for understanding how API calls are made
- General best practices for API authentication and error handling in n8n workflows