Overview

This node operation retrieves multiple payment records from the Gigstack API. It supports fetching all payments or limiting the number of results returned. Users can apply various filters such as payment status, client ID, client email, currency, order by fields, sort direction, creation date range, and metadata key-value pairs to refine the search results. This operation is useful for scenarios where users need to list or analyze payments, generate reports, or synchronize payment data with other systems.

Use Case Examples

1. Retrieve all payments with status 'Succeeded' for a specific client email.
2. Fetch up to 50 payments created after a certain date, sorted by creation timestamp in descending order.
3. Filter payments by currency (e.g., USD) and metadata fields for detailed reporting.

Properties

Output

JSON

• id - Unique identifier of the payment.
• client
  • id - Identifier of the client associated with the payment.
• status - Current status of the payment (e.g., succeeded, canceled).
• currency - Currency used in the payment.
• amount - Amount of the payment.
• timestamp - Timestamp when the payment was created.
• metadata - Additional metadata associated with the payment.

Dependencies

• Gigstack API
• An API key credential for authentication

Troubleshooting

• Ensure the API key credential is correctly configured and has the necessary permissions to access payment data.
• Verify that the filters used are valid and supported by the Gigstack API to avoid errors.
• If the node returns an error about limits, check the 'Limit' property and adjust it within the allowed range (1-100).
• Network or API downtime may cause request failures; retry or check the Gigstack service status.

Links

• Gigstack API - Payments Get Many - Official documentation for retrieving multiple payments via the Gigstack API.