GoCardless BAD icon

GoCardless BAD

Bank Account Data API by GoCardless

Actions16

Agreements → Reconfirm (Post)

AI-generated

Overview

This node interacts with the GoCardless Bank Account Data API, specifically supporting various operations on different resources such as Institutions, Agreements, Requisitions, and Accounts. For the 'Agreements' resource with the 'Reconfirm (Post)' operation, the node sends a POST request to reconfirm an existing agreement by its ID. This is useful in scenarios where an agreement needs to be reconfirmed to ensure its validity or compliance, such as in financial or subscription management workflows.

Use Case Examples

  1. Reconfirm an agreement by providing its Agreement ID to trigger a reconfirmation process via the GoCardless API.
  2. Use this operation to maintain up-to-date agreement statuses in automated billing or compliance systems.

Properties

Name Meaning
Agreement ID The unique identifier of the agreement to be reconfirmed. This is a required string input.

Output

JSON

  • id - The unique identifier of the reconfirmed agreement.
  • status - The current status of the agreement after reconfirmation.
  • reconfirmationDetails - Details about the reconfirmation process and its outcome.

Dependencies

  • Requires an API key credential for authenticating with the GoCardless Bank Account Data API.

Troubleshooting

  • Ensure the Agreement ID provided is valid and exists in the GoCardless system; invalid IDs will cause errors.
  • Check API authentication credentials if requests fail due to authorization errors.
  • Network issues or API downtime can cause request failures; verify connectivity and API status.
  • Error messages related to missing required parameters indicate that the Agreement ID was not provided or is empty.

Links

Discussion