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 allows users to cancel a specific payout by its unique identifier using the Straddle API. It is useful in scenarios where a payout has been initiated but needs to be revoked before completion, such as correcting errors, stopping payments due to changed circumstances, or managing cash flow.
Practical examples:
- A finance team wants to cancel a scheduled payout that was created with incorrect details.
- An automated workflow detects suspicious activity and cancels pending payouts immediately.
- Customer support cancels a payout upon user request before it is processed.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the payout to cancel. |
| Straddle Account Id | (Optional) For platforms: specifies an account ID to set the scope of the cancellation request. |
| Request Id | (Optional) Client-generated identifier for tracing and debugging this specific request. |
| Correlation Id | (Optional) Client-generated identifier to trace and debug a series of related requests. |
| Reason | The reason for cancelling the payout. |
Output
The node outputs the JSON response from the Straddle API after attempting to cancel the payout. This typically includes details about the payout status, confirmation of cancellation, or error information if the cancellation failed.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the Straddle API.
- The base URL for API requests depends on the configured environment (e.g., sandbox or production).
- Proper network connectivity to the Straddle API endpoint.
Troubleshooting
Common issues:
- Invalid or missing payout Id will cause the cancellation to fail.
- Insufficient permissions or invalid API credentials can result in authentication errors.
- Providing an incorrect or unauthorized Straddle Account Id may lead to scope or access errors.
- Missing or empty "Reason" property might cause the API to reject the request.
Error messages:
- Authentication errors: Verify that the API key credential is correctly configured and active.
- Not found errors: Confirm the payout Id exists and is correct.
- Validation errors: Ensure all required fields, especially "Reason", are provided and valid.
- Rate limiting or server errors: Retry after some time or check API status.
Links and References
- Straddle API Documentation (general reference for API endpoints and usage)
- n8n documentation on HTTP Request Node for understanding how API calls are made within n8n nodes.