Actions16
Agreements → Get
AI-generatedOverview
This node interacts with the GoCardless Bank Account Data API to perform various operations related to bank data management. Specifically, the 'Agreements - Get' operation retrieves detailed information about a specific agreement using its ID. This is useful in scenarios where you need to fetch the status, terms, or other details of a particular agreement between parties, such as in financial services or payment processing workflows.
Use Case Examples
- Retrieve details of a specific agreement by providing its Agreement ID to verify its status before processing payments.
- Fetch agreement information to display in a user interface for review or auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Agreement ID | The unique identifier of the agreement to retrieve. This is a required string input used to specify which agreement's details to fetch. |
Output
JSON
id- The unique identifier of the agreement.status- The current status of the agreement.created_at- Timestamp when the agreement was created.details- Additional details or metadata related to the agreement.
Dependencies
- Requires an API key credential for GoCardless Bank Account Data API authentication.
Troubleshooting
- Ensure the Agreement ID provided is correct and exists in the system; otherwise, the node may return an error or empty response.
- Check that the API key credential is valid and has the necessary permissions to access agreement data.
- Network issues or API rate limits may cause failures; verify connectivity and API usage limits.
Links
- GoCardless Bank Account Data API Documentation - Official documentation for the GoCardless Bank Account Data API, including details on agreements and other resources.