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 interacts with the "Paykeys" resource of the Straddle API, specifically performing a refresh operation on an existing paykey via the internal endpoint PUT /v1/internal/paykeys/refresh. The main purpose is to update or refresh the state of a paykey, optionally refreshing its balance.
Typical use cases include:
- Platforms or services that manage payment keys and need to programmatically refresh their status or balance.
- Automated workflows where paykey information must be kept up-to-date without manual intervention.
- Debugging or tracing paykey requests by associating client-generated identifiers.
Example: A payment platform could use this node to refresh the balance of a paykey after a transaction to ensure the latest available funds are reflected in their system.
Properties
| Name | Meaning |
|---|---|
| Straddle Account Id | (Optional) Specifies an account ID to scope the request, used by platforms for multi-account setups. |
| Request Id | (Optional) Client-generated identifier to trace and debug a single request. |
| Correlation Id | (Optional) Client-generated identifier to trace and debug a series of related requests. |
| Key | (Required) The paykey string identifier to refresh. |
| Refresh Balance | (Required) Boolean flag indicating whether to refresh the balance associated with the paykey. |
Output
The node outputs JSON data representing the response from the Straddle API after refreshing the paykey. This typically includes updated paykey details such as status, balance, and any relevant metadata or status messages.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Straddle API.
- The base URL for API requests is dynamically set based on the configured environment credential parameter.
- The node sends HTTP PUT requests with JSON payloads and expects JSON responses.
Troubleshooting
- Invalid or missing Key: If the required "Key" property is not provided or invalid, the API will likely return an error. Ensure the paykey string is correct.
- Authentication errors: Missing or incorrect API credentials will cause authentication failures. Verify the API key credential configuration.
- Network or environment issues: The base URL depends on the environment setting; ensure it matches the intended Straddle environment (e.g., production, sandbox).
- Header misconfiguration: Optional headers like "Straddle Account Id", "Request Id", and "Correlation Id" should be correctly formatted if used; otherwise, omit them.
- API rate limits or server errors: Handle HTTP errors gracefully and consider retry logic if needed.
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.