Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node allows you to cancel a specific charge by its ID using the Straddle API. It is useful in payment processing workflows where you need to programmatically void or cancel a previously created charge, for example, when a customer cancels an order or a payment needs to be reversed before settlement.

Practical examples include:

  • Automatically cancelling charges that fail fraud checks.
  • Voiding charges when an order is cancelled in an e-commerce system.
  • Integrating with customer service tools to allow agents to cancel charges on behalf of customers.

Properties

Name Meaning
Id The unique identifier of the charge to be cancelled.
Straddle Account Id (Optional) For platforms: specifies the account ID to scope the request.
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.
Reason (Optional) Reason for cancelling the charge, sent in the request body.

Output

The node outputs JSON data representing the response from the Straddle API after attempting to cancel the charge. This typically includes details about the cancelled charge status, confirmation messages, or error information if the cancellation failed.

No binary data output is involved.

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/charges/{id}/cancel.

Troubleshooting

  • Invalid Charge ID: If the provided charge ID does not exist or is malformed, the API will return an error. Verify the charge ID is correct.
  • Authentication Errors: Missing or invalid API key credential will cause authentication failures. Ensure valid credentials are configured.
  • Permission Issues: If the API key does not have permission to cancel charges or access the specified account, the request will be denied.
  • Missing Required Fields: The Id property is required; omitting it will prevent the request from being made.
  • Network or Endpoint Errors: Check connectivity and ensure the environment URL is correctly set.

Links and References

Discussion