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 Straddle API to retrieve a list of paykeys, which are payment authorization keys associated with customers and financial institutions. It is useful for scenarios where you need to query and filter paykeys based on various criteria such as customer ID, status, pagination, and sorting preferences.
Practical examples include:
- Fetching all active paykeys for a specific customer to display or audit payment authorizations.
- Retrieving paginated paykey data sorted by creation date for reporting purposes.
- Filtering paykeys by their current status to monitor pending or expired payment authorizations.
Properties
| Name | Meaning |
|---|---|
| Customer Id | Filter paykeys by related customer ID. |
| Page Number | Page number for paginated results. Starts at 1. Default: 1. |
| Page Size | Number of results per page. Default: 100. Maximum: 1000. |
| Status | Filter paykeys by their current status. |
| Sort By | Field to sort results by. Options: Institution Name, Expires At, Created At. |
| Sort Order | Sort direction. Options: Asc (ascending), Desc (descending). |
| Straddle Account Id | For platforms: specify an account id to set the scope of the request (sent as header). |
| Request Id | Optional client-generated identifier to trace and debug a request (sent as header). |
| Correlation Id | Optional client-generated identifier to trace and debug a series of requests (sent as header). |
Output
The node outputs JSON data representing the list of paykeys retrieved from the API. Each paykey object includes detailed information such as:
- Bank account data (routing number, masked account number, account type)
- Status details (message, reason, source, last changed timestamp)
- Verification details (status, method, attempts, completion time)
- Metadata, device info, compliance profile, capabilities, settings, industry info, support channels, and other related nested objects describing the paykey and its context.
No binary data output is indicated.
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 access to the Straddle API endpoint is necessary.
Troubleshooting
- Empty or no results: Verify that filters like Customer Id or Status are correctly set and that the requested page number and size are within valid ranges.
- Authentication errors: Ensure the API key credential is valid and has appropriate permissions.
- Rate limiting or server errors: Check API usage limits and retry after some time if rate limited.
- Invalid header values: When using optional headers like Straddle Account Id, Request Id, or Correlation Id, ensure they conform to expected formats.
Common error messages will typically come from the API response and should be handled accordingly by inspecting the returned status code and message.
Links and References
- Straddle API Documentation (general reference for API endpoints and data models)
- n8n documentation on HTTP Request Node for understanding how API calls are made in custom nodes