Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node updates an existing payout record by its unique identifier. It is designed to interact with a payout management API, allowing users to modify details such as the payout amount, description, payment date, and associated metadata. This operation is useful in financial workflows where payouts need to be adjusted or corrected after creation, for example, updating the scheduled payment date or changing the payout amount due to business requirements.

Practical examples include:

  • Adjusting a payout amount before it is processed.
  • Changing the payment date of a scheduled payout.
  • Adding or updating descriptive information or metadata for tracking purposes.

Properties

Name Meaning
Id The unique identifier of the payout to update (required).
Straddle Account Id Optional header to specify an account ID for scoping the request, typically used by platforms.
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.
Description Description of the payout (required).
Amount Amount of the payout (required).
Payment Date Scheduled payment date for the payout (required).
Metadata User-defined key-value pairs as JSON to attach custom metadata to the payout.

Output

The node outputs the updated payout object in the json field of the output data. This JSON contains the updated payout details including the description, amount, payment date, and any metadata provided. The structure corresponds to the payout resource schema defined by the API.

No binary data output is produced by this node.

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 specified in credentials.
  • The node sends HTTP PUT requests to the endpoint /v1/payouts/{id} to update the payout.

Troubleshooting

  • Missing Required Fields: Ensure that the required fields Id, Description, Amount, and Payment Date are provided; otherwise, the API will reject the request.
  • Invalid Date Format: The Payment Date should be in a valid string format accepted by the API (commonly ISO 8601). Incorrect formats may cause errors.
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Header Misconfiguration: If using optional headers like Straddle Account Id, ensure they are correctly set; incorrect values might lead to authorization or scoping issues.
  • API Endpoint Errors: If the payout ID does not exist or is invalid, the API will return an error indicating the resource was not found.

Links and References

Discussion