GoCardless BAD icon

GoCardless BAD

Bank Account Data API by GoCardless

Actions16

Requisitions → Create

AI-generated

Overview

This node operation creates a requisition in the GoCardless Bank Account Data API. It is used to initiate a request for bank account data access by specifying the institution (bank) and a redirect URL where the user will return after completing consent at the bank. This operation is useful for workflows that require user consent to access bank account information, such as financial applications, account aggregation, or payment initiation services.

Use Case Examples

  1. Creating a requisition to request user consent for accessing bank account data from a specific bank institution.
  2. Redirecting the user to a bank's consent page and handling the return URL after consent is given.

Properties

Name Meaning
Institution ID ID of the institution or bank where the requisition is created, typically obtained from the Institutions List.
Redirect URL URL to which the user is redirected after completing the consent process at the bank.
Reference A custom string identifier to track the requisition.
Agreement ID ID of an existing End-User Agreement if already created.
User Language Language code for the bank UI (e.g., en, es, de).
Account Selection Boolean flag to allow the user to select specific accounts at the bank.
Redirect Immediate Boolean flag to immediately redirect to the return URL after completing the flow, if supported by the bank.

Output

JSON

  • id - Unique identifier of the created requisition.
  • status - Current status of the requisition.
  • institution_id - ID of the institution associated with the requisition.
  • redirect - Redirect URL provided for user return after consent.
  • reference - Custom reference string for tracking the requisition.
  • agreement - ID of the associated End-User Agreement, if any.
  • user_language - Language setting for the bank UI.
  • account_selection - Indicates if account selection by the user is enabled.
  • redirect_immediate - Indicates if immediate redirect after flow completion is enabled.

Dependencies

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

Troubleshooting

  • Ensure the Institution ID is valid and corresponds to an existing institution in the system; invalid IDs will cause errors.
  • The Redirect URL must be a valid URL and accessible by the user; incorrect URLs may cause the flow to fail or not return properly.
  • If using an existing Agreement ID, verify that the agreement is active and valid; otherwise, the requisition creation may fail.
  • Some banks may not support immediate redirect; setting 'Redirect Immediate' to true in such cases may not have the desired effect.

Links

Discussion