Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node interacts with the "Payments" resource of the Straddle API, specifically performing the operation to retrieve a list of payments (get__v1_payments). It allows users to query and filter payment records based on various criteria such as page number, page size, sorting options, payment type and status, date ranges, amounts, and identifiers.

Common scenarios where this node is beneficial include:

  • Retrieving paginated lists of payments for reporting or reconciliation.
  • Filtering payments by status or type to monitor transaction flows.
  • Searching payments by customer or external IDs.
  • Sorting payments by creation date, payment date, amount, or ID for analysis.

Practical example: A finance team could use this node to fetch all completed ACH payments made within a specific date range, sorted by payment date descending, to generate a payout report.

Properties

Name Meaning
Page Number Results page number. Starts at 1. Default is 1.
Page Size Number of results per page. Default 100, max 1000.
Sort By Field to sort results by. Options: Created At, Payment Date, Effective At, Id, Amount.
Sort Order Sort direction. Options: Asc (ascending), Desc (descending).
Payment Type Filter by payment type (JSON array).
Payment Status Filter by payment status (JSON array).
Payment Id Filter by specific payment id (string).
External Id Filter by external id (string).
Customer Id Filter by customer id (string).
Paykey Id Filter by paykey id (string).
Paykey Filter by paykey (string).
Min Amount Minimum payment amount (number).
Max Amount Maximum payment amount (number).
Min Payment Date Minimum payment date (string, e.g., ISO date).
Max Payment Date Maximum payment date (string).
Min Created At Minimum creation date (string).
Max Created At Maximum creation date (string).
Min Effective At Minimum effective date (string).
Max Effective At Maximum effective date (string).
Funding Id Filter by funding id (string).
Search Text Free text search (string).
Default Page Size Default page size (number).
Default Sort Default sort field. Same options as "Sort By".
Default Sort Order Default sort order. Same options as "Sort Order".
Straddle Account Id Optional header to specify account scope for platforms (string).
Request Id Optional client-generated identifier for tracing/debugging a request (header string).
Correlation Id Optional client-generated identifier for tracing/debugging a series of requests (header string).

Output

The node outputs JSON data representing the retrieved payments. Each item in the output corresponds to a payment record with fields as defined by the Straddle API schema for payments. This typically includes details such as payment id, amount, dates (created, payment, effective), status, type, customer info, and related metadata.

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 environment credential parameter.
  • The node uses standard HTTP headers including Accept: application/json and Content-Type: application/json.
  • Optional headers can be set for advanced tracing and scoping (e.g., Straddle Account Id, Request Id, Correlation Id).

Troubleshooting

  • Empty or missing results: Check that the filters (dates, ids, statuses) are correctly specified and that the page number and size are valid.
  • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Invalid parameter values: For example, page size exceeding 1000 or invalid date formats may cause errors.
  • API rate limits or connectivity issues: Network problems or hitting API limits can cause failures; verify network and retry policies.
  • Unexpected response structure: If the API schema changes, the node's output format might differ; check for updates to the node or API.

Links and References

Discussion