Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node allows users to create a payout request via the Straddle API. It is designed for platforms or services that need to initiate payouts to recipients by specifying payment details such as amount, currency, payment date, and descriptive information. Typical use cases include automating vendor payments, customer refunds, or any scenario where scheduled or immediate payouts are required.

For example, an e-commerce platform could use this node to automate payouts to sellers after order completion, specifying the payout amount, currency, and payment date along with metadata and device information for audit purposes.

Properties

Name Meaning
Straddle Account Id Optional header to specify an account ID to scope the request, useful 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.
Paykey Required. Unique identifier for the payee or payout target.
Description Required. Text description of the payout purpose.
Amount Required. Numeric value representing the payout amount.
Currency Required. Currency code (e.g., USD, EUR) for the payout amount.
Payment Date Required. Date string indicating when the payment should be made.
Device Required. JSON object containing device information such as IP address and user agent.
External Id Required. External identifier for the payout, useful for idempotency or reconciliation.
Config Optional JSON object for additional configuration options related to the payout.
Metadata Optional JSON object for user-defined key-value pairs to attach custom metadata to the payout.

Output

The node outputs the response from the Straddle API in the json field of the output data. This typically includes details about the created payout such as its status, identifiers, and any relevant messages returned by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the Straddle API.
  • The base URL for API requests is dynamically set based on the environment specified in credentials.
  • The node sends HTTP requests with JSON bodies and expects JSON responses.

Troubleshooting

  • Missing Required Fields: If required properties like paykey, description, amount, currency, payment_date, device, or external_id are not provided, the API will likely return validation errors. Ensure all required fields are correctly filled.
  • Invalid JSON in Device, Config, or Metadata: These fields expect valid JSON strings. Malformed JSON will cause parsing errors before the request is sent.
  • Authentication Errors: If the API key or token is missing or invalid, the API will reject the request. Verify that the correct API credentials are configured.
  • Date Format Issues: The payment_date must be in a valid date string format accepted by the API (usually ISO 8601). Incorrect formats may cause errors.
  • API Rate Limits or Quotas: Excessive requests might be throttled by the API. Check API documentation for limits.
  • Network or Connectivity Problems: Ensure that the n8n instance can reach the Straddle API endpoint.

Links and References

Discussion