Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node interacts with the Straddle API to retrieve detailed information about a specific Paykey by its ID. The "get__v1_paykeys_id_reveal" operation fetches the full details of a Paykey, which is typically used in payment or payout platforms to reveal sensitive or comprehensive data associated with a payment key.

Common scenarios where this node is beneficial include:

  • Platforms needing to verify or audit payment keys.
  • Retrieving detailed status and bank account information linked to a Paykey.
  • Debugging or tracing payment flows by accessing metadata and verification details.

Practical example:

  • A payment platform uses this node to fetch and display the current status, bank details, and verification state of a Paykey before processing a payout.

Properties

Name Meaning
Id The unique identifier of the Paykey to retrieve (required).
Straddle Account Id Optional header for platforms to specify an account ID to scope the request.
Request Id Optional client-generated identifier to trace and debug this specific request (sent as header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).

Output

The node outputs JSON data representing the full details of the requested Paykey. The structure includes:

  • bank_data: Bank account information such as routing number, masked account number, and account type.
  • status_details: Status message, reason, source, and timestamp of last status change.
  • verification: Verification status, method used, number of attempts, and completion time.
  • metadata: User-defined key-value pairs attached to the Paykey.
  • device: Information about the device involved in the transaction (IP address, user agent).
  • compliance_profile: Compliance-related data including date of birth, SSN last 4 digits, EIN, legal business name, and website.
  • capabilities: Supported payment types and customer types.
  • settings: Charge and payout settings including enabled flags and limits.
  • industry: Merchant category code, sector, and category.
  • support_channels: Support contact information like email, phone, and URL.
  • bank_details: Detailed bank account info including bank name.
  • status_details: Additional status information with messages and reasons.
  • verification: Verification details repeated for clarity.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL is dynamically set based on the environment specified in credentials.
  • HTTP headers can be customized via input properties for tracing and scoping requests.

Troubleshooting

  • Missing or invalid Id: The "Id" property is required; ensure it is provided and correctly formatted.
  • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
  • Request tracing: Use "Request Id" and "Correlation Id" headers to debug issues with support or logs.
  • Scope issues: If using "Straddle Account Id", confirm the account exists and the API key has access rights.
  • API endpoint errors: Check network connectivity and that the environment URL is correct.

Common error messages might include unauthorized access, resource not found (invalid Paykey ID), or bad request due to malformed inputs.

Links and References

Discussion