Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node operation updates the status of a specific payment by its ID in the Straddle payment system. It is useful for platforms or services that need to programmatically change the state of payments, such as marking them as paid, failed, cancelled, or on hold. This can help automate payment workflows, reconciliation processes, or error handling.

Practical examples:

  • Marking a payment as "paid" after confirmation from a bank.
  • Setting a payment status to "failed" with a reason like "insufficient funds".
  • Cancelling a scheduled payment before it is processed.
  • Putting a payment "on hold" pending further review.

Properties

Name Meaning
Id The unique identifier of the payment whose status you want to update.
Straddle Account Id (Optional) For platforms to specify an account ID and set the scope of the request via header.
Request Id (Optional) Client-generated identifier to trace and debug this specific request via header.
Correlation Id (Optional) Client-generated identifier to trace and debug a series of related requests via header.
Status The new status to assign to the payment. Options: Created, Scheduled, Failed, Cancelled, On Hold, Pending, Paid, Reversed.
Reason The reason for the status change. Options include: Insufficient Funds, Closed Bank Account, Invalid Bank Account, Invalid Routing, Disputed, Payment Stopped, Owner Deceased, Frozen Bank Account, Risk Review, Fraudulent, Duplicate Entry, Invalid Paykey, Payment Blocked, Amount Too Large, Too Many Attempts, Internal System Error, User Request, Ok, Other Network Return, Payout Refused.
Message Optional message providing additional information about the status update.

Output

The node outputs JSON data representing the updated payment object returned by the API after the status change. This typically includes the payment's current details, including its new status, any status messages, reasons, timestamps, and other relevant metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL for API requests depends on the configured environment (e.g., sandbox or production).
  • Proper network connectivity to the Straddle API endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing payment ID will cause the API to reject the request.
    • Unauthorized errors if the API key credential is incorrect or lacks permissions.
    • Providing an invalid status or reason value not supported by the API.
    • Network connectivity problems preventing communication with the API.
  • Error messages and resolutions:

    • "Unauthorized" — Check that the API key credential is correctly configured and valid.
    • "Payment not found" — Verify the payment ID is correct and exists.
    • "Invalid status value" — Ensure the status property uses one of the allowed options.
    • "Invalid reason value" — Use a valid reason option matching the API specification.
    • Timeouts or network errors — Confirm network access and API endpoint availability.

Links and References

Discussion