Overview

This node integrates with the GoCardless Bank Account Data API (BAD) to perform various operations related to financial data management. Specifically, for the 'Agreements' resource with the 'List' operation, it retrieves a list of agreements associated with the user's account. This is useful for scenarios where users need to manage or review their financial agreements, such as direct debit mandates or payment authorizations. Practical examples include fetching all active agreements for reconciliation or auditing purposes.

Use Case Examples

1. List all agreements to display in a dashboard.
2. Retrieve agreements to verify active payment mandates before processing transactions.

Output

JSON

• id - Unique identifier of the agreement
• status - Current status of the agreement
• created_at - Timestamp when the agreement was created
• details - Additional details about the agreement

Dependencies

• Requires an API key credential for GoCardless Bank Account Data API authentication.

Troubleshooting

• Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key is correctly configured in the node credentials.
• API rate limits may cause request failures; handle such errors by implementing retries or backoff strategies.
• Network connectivity issues can prevent the node from reaching the GoCardless API endpoint; verify network settings and firewall rules.

Links

• GoCardless Bank Account Data API - Agreements List - Official API documentation for listing agreements using the GoCardless Bank Account Data API.