Actions16
Agreements → Create
AI-generatedOverview
This node integrates with the GoCardless Bank Account Data API to create agreements. It allows users to establish agreements with financial institutions by specifying parameters such as the institution ID, the maximum number of historical days for data access, the duration for which access is valid, and the scopes of data access (details, balances, transactions). This is useful for automating financial data agreements in workflows, such as setting up data sharing agreements for account information retrieval or transaction monitoring.
Use Case Examples
- Creating an agreement with a bank to access account details and transactions for the past 90 days.
- Automating the setup of data access agreements with multiple institutions for financial analysis.
Properties
| Name | Meaning |
|---|---|
| Institution ID | The unique identifier of the financial institution with which to create the agreement. This is required to specify the target institution. |
| Max Historical Days | The maximum number of past days for which historical data can be accessed under the agreement. Defaults to 90 days. |
| Access Valid For Days | The number of days the access granted by the agreement remains valid. Defaults to 90 days. |
| Scopes | The types of data access requested in the agreement. Options include Details (account details), Balances (account balances), and Transactions (account transactions). Multiple scopes can be selected. |
Output
JSON
agreementId- The unique identifier of the created agreement.institutionId- The institution ID associated with the agreement.maxHistoricalDays- The maximum number of historical days allowed by the agreement.accessValidForDays- The duration in days for which the access is valid.scopes- The scopes of data access granted by the agreement.status- The current status of the agreement (e.g., active, pending).
Dependencies
- Requires an API key credential for GoCardless Bank Account Data API authentication.
Troubleshooting
- Ensure the Institution ID is valid and corresponds to an institution supported by the GoCardless API.
- Verify that the API key credential is correctly configured and has the necessary permissions.
- Check that the scopes selected are supported by the institution and the API.
- Common errors may include authentication failures, invalid parameters, or network issues. Review error messages for specific details and verify input values.
Links
- GoCardless Bank Account Data API Documentation - Official documentation for the GoCardless Bank Account Data API, including details on agreements and other resources.