Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node interacts with the Straddle API to retrieve detailed information about a specific platform by its unique identifier. It is useful when you need to fetch comprehensive data about a platform entity within your workflow, such as for auditing, reporting, or integration purposes.

A practical example would be automating the retrieval of platform details in response to an event, enabling downstream processing like updating records in a CRM or triggering notifications based on platform status.

Properties

Name Meaning
Platform Id The unique identifier of the platform to retrieve information for. (Required)
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.

Output

The node outputs JSON data representing the full details of the requested platform. This includes structured information such as:

  • Business profile and address
  • Industry and support channels
  • Capabilities (payment types supported, customer types)
  • Settings (charges, payouts)
  • Bank account details and verification status
  • Status details including messages and reasons
  • Compliance and representative information

The output JSON structure is rich and nested, reflecting the complex schema of a platform entity in the Straddle system.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL for API requests is dynamically constructed from the environment specified in credentials.
  • The node expects standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Missing or invalid Platform Id: Ensure the Platform Id property is provided and correctly formatted; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Request tracing: Use the optional Request Id and Correlation Id properties to help trace and debug issues across distributed systems.
  • API endpoint availability: Confirm that the target environment (base URL) is reachable and the Straddle API service is operational.

Common error messages will likely relate to authentication failures, resource not found (invalid Platform Id), or network connectivity issues.

Links and References

Discussion