Actions16
Agreements → Delete
AI-generatedOverview
This node integrates with the GoCardless Bank Account Data API to manage agreements. Specifically, the 'Delete' operation under the 'Agreements' resource allows users to delete an existing agreement by providing its Agreement ID. This is useful in scenarios where an agreement is no longer needed or must be removed from the system, such as cancelling a mandate or cleaning up outdated agreements.
Use Case Examples
- Deleting an agreement by specifying its unique Agreement ID to revoke access or cancel the mandate.
- Automating agreement management workflows by removing agreements that are no longer valid or required.
Properties
| Name | Meaning |
|---|---|
| Agreement ID | The unique identifier of the agreement to be deleted. This is a required string input to specify which agreement to remove. |
Output
JSON
id- The ID of the deleted agreement, confirming which agreement was removed.status- The status or result of the delete operation, indicating success or failure.
Dependencies
- Requires an API key credential for GoCardless Bank Account Data API authentication.
Troubleshooting
- Ensure the Agreement ID provided is correct and exists; otherwise, the delete operation will fail.
- Check API authentication credentials if the node returns authorization errors.
- Handle errors gracefully in workflows to manage cases where the agreement cannot be deleted due to dependencies or restrictions.
Links
- GoCardless Bank Account Data API - Delete Agreement - Official API documentation for deleting agreements using the GoCardless Bank Account Data API.