Initial commit

This is definitely not functional yet. Signed-off-by: Jacob Kiers <code@kiers.eu>
2024-10-04 20:27:23 +02:00
commit f0b8df90b9
582 changed files with 43994 additions and 0 deletions
--- a/gocardless-bankaccount-data-api/docs/Account.md
+++ b/gocardless-bankaccount-data-api/docs/Account.md
@@ -0,0 +1,17 @@
+# Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | The ID of this Account, used to refer to this account in other API calls. | [optional][readonly]
+**created** | Option<**String**> | The date & time at which the account object was created. | [optional][readonly]
+**last_accessed** | Option<**String**> | The date & time at which the account object was last accessed. | [optional][readonly]
+**iban** | Option<**String**> | The Account IBAN | [optional][readonly]
+**status** | Option<**String**> | The processing status of this account. | [optional][readonly]
+**institution_id** | Option<**String**> | The ASPSP associated with this account. | [optional][readonly]
+**owner_name** | Option<**String**> | The name of the account owner. | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/AccountBalance.md
+++ b/gocardless-bankaccount-data-api/docs/AccountBalance.md
@@ -0,0 +1,11 @@
+# AccountBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balances** | Option<[**Vec<models::BalanceSchema>**](BalanceSchema.md)> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/AccountDetail.md
+++ b/gocardless-bankaccount-data-api/docs/AccountDetail.md
@@ -0,0 +1,11 @@
+# AccountDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**models::DetailSchema**](DetailSchema.md) | account | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/AccountSchema.md
+++ b/gocardless-bankaccount-data-api/docs/AccountSchema.md
@@ -0,0 +1,16 @@
+# AccountSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iban** | Option<**String**> | iban | [optional]
+**bban** | Option<**String**> | bban | [optional]
+**pan** | Option<**String**> | pan | [optional]
+**masked_pan** | Option<**String**> | maskedPan | [optional]
+**msisdn** | Option<**String**> | msisdn | [optional]
+**currency** | Option<**String**> | currency | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/AccountsApi.md
+++ b/gocardless-bankaccount-data-api/docs/AccountsApi.md
@@ -0,0 +1,134 @@
+# \AccountsApi
+
+All URIs are relative to *https://bankaccountdata.gocardless.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**retrieve_account_balances**](AccountsApi.md#retrieve_account_balances) | **GET** /api/v2/accounts/{id}/balances/ | 
+[**retrieve_account_details**](AccountsApi.md#retrieve_account_details) | **GET** /api/v2/accounts/{id}/details/ | 
+[**retrieve_account_metadata**](AccountsApi.md#retrieve_account_metadata) | **GET** /api/v2/accounts/{id}/ | 
+[**retrieve_account_transactions**](AccountsApi.md#retrieve_account_transactions) | **GET** /api/v2/accounts/{id}/transactions/ | 
+
+
+
+## retrieve_account_balances
+
+> models::AccountBalance retrieve_account_balances(id)
+
+
+Access account balances.  Balances will be returned in Berlin Group PSD2 format.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** |  | [required] |
+
+### Return type
+
+[**models::AccountBalance**](AccountBalance.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_account_details
+
+> models::AccountDetail retrieve_account_details(id)
+
+
+Access account details.  Account details will be returned in Berlin Group PSD2 format.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** |  | [required] |
+
+### Return type
+
+[**models::AccountDetail**](AccountDetail.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_account_metadata
+
+> models::Account retrieve_account_metadata(id)
+
+
+Access account metadata.  Information about the account record, such as the processing status and IBAN.  Account status is recalculated based on the error count in the latest req.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** |  | [required] |
+
+### Return type
+
+[**models::Account**](Account.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_account_transactions
+
+> models::BankTransaction retrieve_account_transactions(id, date_from, date_to)
+
+
+Access account transactions.  Transactions will be returned in Berlin Group PSD2 format.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** |  | [required] |
+**date_from** | Option<**String**> |  |  |
+**date_to** | Option<**String**> |  |  |
+
+### Return type
+
+[**models::BankTransaction**](BankTransaction.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/gocardless-bankaccount-data-api/docs/AgreementsApi.md
+++ b/gocardless-bankaccount-data-api/docs/AgreementsApi.md
@@ -0,0 +1,165 @@
+# \AgreementsApi
+
+All URIs are relative to *https://bankaccountdata.gocardless.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**accept_eua**](AgreementsApi.md#accept_eua) | **PUT** /api/v2/agreements/enduser/{id}/accept/ | 
+[**create_eua**](AgreementsApi.md#create_eua) | **POST** /api/v2/agreements/enduser/ | 
+[**delete_eua_by_id**](AgreementsApi.md#delete_eua_by_id) | **DELETE** /api/v2/agreements/enduser/{id}/ | 
+[**retrieve_all_euas_for_an_end_user**](AgreementsApi.md#retrieve_all_euas_for_an_end_user) | **GET** /api/v2/agreements/enduser/ | 
+[**retrieve_eua_by_id**](AgreementsApi.md#retrieve_eua_by_id) | **GET** /api/v2/agreements/enduser/{id}/ | 
+
+
+
+## accept_eua
+
+> models::EndUserAgreement accept_eua(id, enduser_acceptance_details_request)
+
+
+Accept an end-user agreement via the API
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | A UUID string identifying this end user agreement. | [required] |
+**enduser_acceptance_details_request** | [**EnduserAcceptanceDetailsRequest**](EnduserAcceptanceDetailsRequest.md) |  | [required] |
+
+### Return type
+
+[**models::EndUserAgreement**](EndUserAgreement.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## create_eua
+
+> models::EndUserAgreement create_eua(end_user_agreement_request)
+
+
+API endpoints related to end-user agreements.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**end_user_agreement_request** | [**EndUserAgreementRequest**](EndUserAgreementRequest.md) |  | [required] |
+
+### Return type
+
+[**models::EndUserAgreement**](EndUserAgreement.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## delete_eua_by_id
+
+> delete_eua_by_id(id)
+
+
+Delete an end user agreement
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | A UUID string identifying this end user agreement. | [required] |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_all_euas_for_an_end_user
+
+> models::PaginatedEndUserAgreementList retrieve_all_euas_for_an_end_user(limit, offset)
+
+
+API endpoints related to end-user agreements.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**limit** | Option<**i32**> | Number of results to return per page. |  |[default to 100]
+**offset** | Option<**i32**> | The initial zero-based index from which to return the results. |  |[default to 0]
+
+### Return type
+
+[**models::PaginatedEndUserAgreementList**](PaginatedEndUserAgreementList.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_eua_by_id
+
+> models::EndUserAgreement retrieve_eua_by_id(id)
+
+
+Retrieve end user agreement by ID
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | A UUID string identifying this end user agreement. | [required] |
+
+### Return type
+
+[**models::EndUserAgreement**](EndUserAgreement.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/gocardless-bankaccount-data-api/docs/BalanceAmountSchema.md
+++ b/gocardless-bankaccount-data-api/docs/BalanceAmountSchema.md
@@ -0,0 +1,12 @@
+# BalanceAmountSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | amount | 
+**currency** | **String** | currency | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/BalanceSchema.md
+++ b/gocardless-bankaccount-data-api/docs/BalanceSchema.md
@@ -0,0 +1,16 @@
+# BalanceSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance_amount** | [**models::BalanceAmountSchema**](BalanceAmountSchema.md) | balanceAmount | 
+**balance_type** | **String** | balanceType | 
+**credit_limit_included** | Option<**bool**> | creditLimitIncluded | [optional]
+**last_change_date_time** | Option<**String**> | lastChangeDateTime | [optional]
+**reference_date** | Option<**String**> | referenceDate | [optional]
+**last_committed_transaction** | Option<**String**> | lastCommittedTransaction | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/BankTransaction.md
+++ b/gocardless-bankaccount-data-api/docs/BankTransaction.md
@@ -0,0 +1,12 @@
+# BankTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**booked** | [**Vec<models::TransactionSchema>**](TransactionSchema.md) |  | 
+**pending** | Option<[**Vec<models::TransactionSchema>**](TransactionSchema.md)> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/CurrencyExchangeSchema.md
+++ b/gocardless-bankaccount-data-api/docs/CurrencyExchangeSchema.md
@@ -0,0 +1,16 @@
+# CurrencyExchangeSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_currency** | Option<**String**> | sourceCurrency | [optional]
+**exchange_rate** | Option<**String**> | exchangeRate | [optional]
+**unit_currency** | Option<**String**> | unitCurrency | [optional]
+**target_currency** | Option<**String**> | targetCurrency | [optional]
+**quotation_date** | Option<**String**> | quotationDate | [optional]
+**contract_identification** | Option<**String**> | contractIdentification | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/DetailSchema.md
+++ b/gocardless-bankaccount-data-api/docs/DetailSchema.md
@@ -0,0 +1,28 @@
+# DetailSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource_id** | Option<**String**> | resourceId | [optional]
+**iban** | Option<**String**> | iban | [optional]
+**bban** | Option<**String**> | bban | [optional]
+**msisdn** | Option<**String**> | msisdn | [optional]
+**currency** | Option<**String**> | currency | [optional]
+**owner_name** | Option<**String**> | ownerName | [optional]
+**name** | Option<**String**> | name | [optional]
+**display_name** | Option<**String**> | displayName | [optional]
+**product** | Option<**String**> | product | [optional]
+**cash_account_type** | Option<**String**> | cashAccountType | [optional]
+**status** | Option<**String**> | status | [optional]
+**bic** | Option<**String**> | bic | [optional]
+**linked_accounts** | Option<**String**> | linkedAccounts | [optional]
+**masked_pan** | Option<**String**> | maskedPan | [optional]
+**usage** | Option<**String**> | usage | [optional]
+**details** | Option<**String**> | details | [optional]
+**owner_address_unstructured** | Option<**Vec<String>**> | ownerAddressUnstructured | [optional]
+**owner_address_structured** | Option<[**models::OwnerAddressStructuredSchema**](OwnerAddressStructuredSchema.md)> | ownerAddressStructured | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/EndUserAgreement.md
+++ b/gocardless-bankaccount-data-api/docs/EndUserAgreement.md
@@ -0,0 +1,17 @@
+# EndUserAgreement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | The ID of this End User Agreement, used to refer to this end user agreement in other API calls. | [optional][readonly]
+**created** | Option<**String**> | The date & time at which the end user agreement was created. | [optional][readonly]
+**institution_id** | **String** | an Institution ID for this EUA | 
+**max_historical_days** | Option<**i32**> | Maximum number of days of transaction data to retrieve. | [optional][default to 90]
+**access_valid_for_days** | Option<**i32**> | Number of days from acceptance that the access can be used. | [optional][default to 90]
+**access_scope** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | Array containing one or several values of ['balances', 'details', 'transactions'] | [optional][default to ["balances","details","transactions"]]
+**accepted** | Option<**String**> | The date & time at which the end user accepted the agreement. | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/EndUserAgreementRequest.md
+++ b/gocardless-bankaccount-data-api/docs/EndUserAgreementRequest.md
@@ -0,0 +1,14 @@
+# EndUserAgreementRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**institution_id** | **String** | an Institution ID for this EUA | 
+**max_historical_days** | Option<**i32**> | Maximum number of days of transaction data to retrieve. | [optional][default to 90]
+**access_valid_for_days** | Option<**i32**> | Number of days from acceptance that the access can be used. | [optional][default to 90]
+**access_scope** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | Array containing one or several values of ['balances', 'details', 'transactions'] | [optional][default to ["balances","details","transactions"]]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/EnduserAcceptanceDetailsRequest.md
+++ b/gocardless-bankaccount-data-api/docs/EnduserAcceptanceDetailsRequest.md
@@ -0,0 +1,12 @@
+# EnduserAcceptanceDetailsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_agent** | **String** |  | 
+**ip_address** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/ErrorResponse.md
+++ b/gocardless-bankaccount-data-api/docs/ErrorResponse.md
@@ -0,0 +1,14 @@
+# ErrorResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**summary** | **String** |  | 
+**detail** | **String** |  | 
+**r#type** | Option<**String**> |  | [optional]
+**status_code** | **i32** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/InstitutionsApi.md
+++ b/gocardless-bankaccount-data-api/docs/InstitutionsApi.md
@@ -0,0 +1,82 @@
+# \InstitutionsApi
+
+All URIs are relative to *https://bankaccountdata.gocardless.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**retrieve_all_supported_institutions_in_a_given_country**](InstitutionsApi.md#retrieve_all_supported_institutions_in_a_given_country) | **GET** /api/v2/institutions/ | 
+[**retrieve_institution**](InstitutionsApi.md#retrieve_institution) | **GET** /api/v2/institutions/{id}/ | 
+
+
+
+## retrieve_all_supported_institutions_in_a_given_country
+
+> Vec<models::Integration> retrieve_all_supported_institutions_in_a_given_country(access_scopes_supported, account_selection_supported, business_accounts_supported, card_accounts_supported, corporate_accounts_supported, country, payment_submission_supported, payments_enabled, pending_transactions_supported, private_accounts_supported, read_debtor_account_supported, read_refund_account_supported, ssn_verification_supported)
+
+
+List all available institutions
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**access_scopes_supported** | Option<**String**> | Boolean value, indicating if access scopes are supported |  |
+**account_selection_supported** | Option<**String**> | Boolean value, indicating if account selection is supported |  |
+**business_accounts_supported** | Option<**String**> | Boolean value, indicating if business accounts are supported |  |
+**card_accounts_supported** | Option<**String**> | Boolean value, indicating if card accounts are supported |  |
+**corporate_accounts_supported** | Option<**String**> | Boolean value, indicating if corporate accounts are supported |  |
+**country** | Option<**String**> | ISO 3166 two-character country code |  |
+**payment_submission_supported** | Option<**String**> | Boolean value, indicating if payment submission is supported |  |
+**payments_enabled** | Option<**String**> | Boolean value, indicating if payments are supported |  |
+**pending_transactions_supported** | Option<**String**> | Boolean value, indicating if pending transactions are supported |  |
+**private_accounts_supported** | Option<**String**> | Boolean value, indicating if private accounts are supported |  |
+**read_debtor_account_supported** | Option<**String**> | Boolean value, indicating if debtor account can be read before submitting payment |  |
+**read_refund_account_supported** | Option<**String**> | Boolean value, indicating if read refund account is supported |  |
+**ssn_verification_supported** | Option<**String**> | Boolean value, indicating if ssn verification is supported |  |
+
+### Return type
+
+[**Vec<models::Integration>**](Integration.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_institution
+
+> models::IntegrationRetrieve retrieve_institution(id)
+
+
+Get details about a specific Institution and its supported features
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** |  | [required] |
+
+### Return type
+
+[**models::IntegrationRetrieve**](IntegrationRetrieve.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/gocardless-bankaccount-data-api/docs/Integration.md
+++ b/gocardless-bankaccount-data-api/docs/Integration.md
@@ -0,0 +1,16 @@
+# Integration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**bic** | Option<**String**> |  | [optional]
+**transaction_total_days** | Option<**String**> |  | [optional][default to 90]
+**countries** | **Vec<String>** |  | 
+**logo** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/IntegrationRetrieve.md
+++ b/gocardless-bankaccount-data-api/docs/IntegrationRetrieve.md
@@ -0,0 +1,19 @@
+# IntegrationRetrieve
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**bic** | Option<**String**> |  | [optional]
+**transaction_total_days** | Option<**String**> |  | [optional][default to 90]
+**countries** | **Vec<String>** |  | 
+**logo** | **String** |  | 
+**supported_payments** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) |  | 
+**supported_features** | [**Vec<serde_json::Value>**](serde_json::Value.md) |  | 
+**identification_codes** | [**Vec<serde_json::Value>**](serde_json::Value.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/JwtObtainPairRequest.md
+++ b/gocardless-bankaccount-data-api/docs/JwtObtainPairRequest.md
@@ -0,0 +1,12 @@
+# JwtObtainPairRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**secret_id** | **String** | Secret id from /user-secrets/ | 
+**secret_key** | **String** | Secret key from /user-secrets/ | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/JwtRefreshRequest.md
+++ b/gocardless-bankaccount-data-api/docs/JwtRefreshRequest.md
@@ -0,0 +1,11 @@
+# JwtRefreshRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**refresh** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/OwnerAddressStructuredSchema.md
+++ b/gocardless-bankaccount-data-api/docs/OwnerAddressStructuredSchema.md
@@ -0,0 +1,15 @@
+# OwnerAddressStructuredSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**street_name** | Option<**String**> | streetName | [optional]
+**building_number** | Option<**String**> | buildingNumber | [optional]
+**town_name** | Option<**String**> | townName | [optional]
+**post_code** | Option<**String**> | postCode | [optional]
+**country** | Option<**String**> | country | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/PaginatedEndUserAgreementList.md
+++ b/gocardless-bankaccount-data-api/docs/PaginatedEndUserAgreementList.md
@@ -0,0 +1,14 @@
+# PaginatedEndUserAgreementList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **i32** |  | 
+**next** | Option<**String**> |  | [optional]
+**previous** | Option<**String**> |  | [optional]
+**results** | [**Vec<models::EndUserAgreement>**](EndUserAgreement.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/PaginatedRequisitionList.md
+++ b/gocardless-bankaccount-data-api/docs/PaginatedRequisitionList.md
@@ -0,0 +1,14 @@
+# PaginatedRequisitionList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **i32** |  | 
+**next** | Option<**String**> |  | [optional]
+**previous** | Option<**String**> |  | [optional]
+**results** | [**Vec<models::Requisition>**](Requisition.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/Requisition.md
+++ b/gocardless-bankaccount-data-api/docs/Requisition.md
@@ -0,0 +1,23 @@
+# Requisition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<[**uuid::Uuid**](uuid::Uuid.md)> |  | [optional][readonly]
+**created** | Option<**String**> | The date & time at which the requisition was created. | [optional][readonly]
+**redirect** | Option<**String**> | redirect URL to your application after end-user authorization with ASPSP | 
+**status** | Option<[**models::StatusEnum**](StatusEnum.md)> | status of this requisition | [optional][readonly]
+**institution_id** | **String** | an Institution ID for this Requisition | 
+**agreement** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | EUA associated with this requisition | [optional]
+**reference** | Option<**String**> | additional ID to identify the end user | [optional]
+**accounts** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | array of account IDs retrieved within a scope of this requisition | [optional][readonly]
+**user_language** | Option<**String**> | A two-letter country code (ISO 639-1) | [optional]
+**link** | Option<**String**> | link to initiate authorization with Institution | [optional][readonly][default to https://ob.gocardless.com/psd2/start/3fa85f64-5717-4562-b3fc-2c963f66afa6/{$INSTITUTION_ID}]
+**ssn** | Option<**String**> | optional SSN field to verify ownership of the account | [optional]
+**account_selection** | Option<**bool**> | option to enable account selection view for the end user | [optional][default to false]
+**redirect_immediate** | Option<**bool**> | enable redirect back to the client after account list received | [optional][default to false]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/RequisitionRequest.md
+++ b/gocardless-bankaccount-data-api/docs/RequisitionRequest.md
@@ -0,0 +1,18 @@
+# RequisitionRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect** | Option<**String**> | redirect URL to your application after end-user authorization with ASPSP | 
+**institution_id** | **String** | an Institution ID for this Requisition | 
+**agreement** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | EUA associated with this requisition | [optional]
+**reference** | Option<**String**> | additional ID to identify the end user | [optional]
+**user_language** | Option<**String**> | A two-letter country code (ISO 639-1) | [optional]
+**ssn** | Option<**String**> | optional SSN field to verify ownership of the account | [optional]
+**account_selection** | Option<**bool**> | option to enable account selection view for the end user | [optional][default to false]
+**redirect_immediate** | Option<**bool**> | enable redirect back to the client after account list received | [optional][default to false]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/RequisitionsApi.md
+++ b/gocardless-bankaccount-data-api/docs/RequisitionsApi.md
@@ -0,0 +1,133 @@
+# \RequisitionsApi
+
+All URIs are relative to *https://bankaccountdata.gocardless.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_requisition**](RequisitionsApi.md#create_requisition) | **POST** /api/v2/requisitions/ | 
+[**delete_requisition_by_id**](RequisitionsApi.md#delete_requisition_by_id) | **DELETE** /api/v2/requisitions/{id}/ | 
+[**requisition_by_id**](RequisitionsApi.md#requisition_by_id) | **GET** /api/v2/requisitions/{id}/ | 
+[**retrieve_all_requisitions**](RequisitionsApi.md#retrieve_all_requisitions) | **GET** /api/v2/requisitions/ | 
+
+
+
+## create_requisition
+
+> models::SpectacularRequisition create_requisition(requisition_request)
+
+
+Create a new requisition
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**requisition_request** | [**RequisitionRequest**](RequisitionRequest.md) |  | [required] |
+
+### Return type
+
+[**models::SpectacularRequisition**](SpectacularRequisition.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## delete_requisition_by_id
+
+> delete_requisition_by_id(id)
+
+
+Delete requisition and its end user agreement
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | A UUID string identifying this requisition. | [required] |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## requisition_by_id
+
+> models::Requisition requisition_by_id(id)
+
+
+Retrieve a requisition by ID
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | A UUID string identifying this requisition. | [required] |
+
+### Return type
+
+[**models::Requisition**](Requisition.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## retrieve_all_requisitions
+
+> models::PaginatedRequisitionList retrieve_all_requisitions(limit, offset)
+
+
+Retrieve all requisitions belonging to the company
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**limit** | Option<**i32**> | Number of results to return per page. |  |[default to 100]
+**offset** | Option<**i32**> | The initial zero-based index from which to return the results. |  |[default to 0]
+
+### Return type
+
+[**models::PaginatedRequisitionList**](PaginatedRequisitionList.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/gocardless-bankaccount-data-api/docs/SpectacularJwtObtain.md
+++ b/gocardless-bankaccount-data-api/docs/SpectacularJwtObtain.md
@@ -0,0 +1,14 @@
+# SpectacularJwtObtain
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access** | Option<**String**> | Your access token | [optional][readonly]
+**access_expires** | Option<**i32**> | Access token expires in seconds | [optional][readonly][default to 86400]
+**refresh** | Option<**String**> | Your refresh token | [optional][readonly]
+**refresh_expires** | Option<**i32**> | Refresh token expires in seconds | [optional][readonly][default to 2592000]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/SpectacularJwtRefresh.md
+++ b/gocardless-bankaccount-data-api/docs/SpectacularJwtRefresh.md
@@ -0,0 +1,12 @@
+# SpectacularJwtRefresh
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access** | Option<**String**> | Your access token | [optional][readonly]
+**access_expires** | Option<**i32**> | Access token expires in seconds | [optional][readonly][default to 86400]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/SpectacularRequisition.md
+++ b/gocardless-bankaccount-data-api/docs/SpectacularRequisition.md
@@ -0,0 +1,23 @@
+# SpectacularRequisition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<[**uuid::Uuid**](uuid::Uuid.md)> |  | [optional][readonly]
+**created** | Option<**String**> | The date & time at which the requisition was created. | [optional][readonly]
+**redirect** | Option<**String**> | redirect URL to your application after end-user authorization with ASPSP | 
+**status** | Option<[**models::StatusEnum**](StatusEnum.md)> | status of this requisition | [optional][readonly]
+**institution_id** | **String** | an Institution ID for this Requisition | 
+**agreement** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | EUA associated with this requisition | [optional]
+**reference** | Option<**String**> | additional ID to identify the end user | [optional]
+**accounts** | Option<[**Vec<serde_json::Value>**](serde_json::Value.md)> | array of account IDs retrieved within a scope of this requisition | [optional][readonly][default to []]
+**user_language** | Option<**String**> | A two-letter country code (ISO 639-1) | [optional]
+**link** | Option<**String**> | link to initiate authorization with Institution | [optional][readonly][default to https://ob.gocardless.com/psd2/start/3fa85f64-5717-4562-b3fc-2c963f66afa6/{$INSTITUTION_ID}]
+**ssn** | Option<**String**> | optional SSN field to verify ownership of the account | [optional]
+**account_selection** | Option<**bool**> | option to enable account selection view for the end user | [optional][default to false]
+**redirect_immediate** | Option<**bool**> | enable redirect back to the client after account list received | [optional][default to false]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/StatusEnum.md
+++ b/gocardless-bankaccount-data-api/docs/StatusEnum.md
@@ -0,0 +1,22 @@
+# StatusEnum
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| Cr | CR |
+| Id | ID |
+| Ln | LN |
+| Rj | RJ |
+| Er | ER |
+| Su | SU |
+| Ex | EX |
+| Gc | GC |
+| Ua | UA |
+| Ga | GA |
+| Sa | SA |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/TokenApi.md
+++ b/gocardless-bankaccount-data-api/docs/TokenApi.md
@@ -0,0 +1,70 @@
+# \TokenApi
+
+All URIs are relative to *https://bankaccountdata.gocardless.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_a_new_access_token**](TokenApi.md#get_a_new_access_token) | **POST** /api/v2/token/refresh/ | 
+[**obtain_new_access_slash_refresh_token_pair**](TokenApi.md#obtain_new_access_slash_refresh_token_pair) | **POST** /api/v2/token/new/ | 
+
+
+
+## get_a_new_access_token
+
+> models::SpectacularJwtRefresh get_a_new_access_token(jwt_refresh_request)
+
+
+Refresh access token
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**jwt_refresh_request** | [**JwtRefreshRequest**](JwtRefreshRequest.md) |  | [required] |
+
+### Return type
+
+[**models::SpectacularJwtRefresh**](SpectacularJWTRefresh.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## obtain_new_access_slash_refresh_token_pair
+
+> models::SpectacularJwtObtain obtain_new_access_slash_refresh_token_pair(jwt_obtain_pair_request)
+
+
+Obtain JWT pair
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**jwt_obtain_pair_request** | [**JwtObtainPairRequest**](JwtObtainPairRequest.md) |  | [required] |
+
+### Return type
+
+[**models::SpectacularJwtObtain**](SpectacularJWTObtain.md)
+
+### Authorization
+
+[jwtAuth](../README.md#jwtAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/gocardless-bankaccount-data-api/docs/TransactionAmountSchema.md
+++ b/gocardless-bankaccount-data-api/docs/TransactionAmountSchema.md
@@ -0,0 +1,12 @@
+# TransactionAmountSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **String** | amount | 
+**currency** | **String** | currency | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/gocardless-bankaccount-data-api/docs/TransactionSchema.md
+++ b/gocardless-bankaccount-data-api/docs/TransactionSchema.md
@@ -0,0 +1,37 @@
+# TransactionSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | Option<**String**> | transactionId | [optional]
+**entry_reference** | Option<**String**> | entryReference | [optional]
+**end_to_end_id** | Option<**String**> | endToEndId | [optional]
+**mandate_id** | Option<**String**> | mandateId | [optional]
+**check_id** | Option<**String**> | checkId | [optional]
+**creditor_id** | Option<**String**> | creditorId | [optional]
+**booking_date** | Option<**String**> | bookingDate | [optional]
+**value_date** | Option<**String**> | valueDate | [optional]
+**booking_date_time** | Option<**String**> | bookingDateTime | [optional]
+**value_date_time** | Option<**String**> | valueDateTime | [optional]
+**transaction_amount** | [**models::TransactionAmountSchema**](TransactionAmountSchema.md) | transactionAmount | 
+**currency_exchange** | Option<[**Vec<models::CurrencyExchangeSchema>**](CurrencyExchangeSchema.md)> |  | [optional]
+**creditor_name** | Option<**String**> | creditorName | [optional]
+**creditor_account** | Option<[**models::AccountSchema**](AccountSchema.md)> | creditorAccount | [optional]
+**ultimate_creditor** | Option<**String**> | ultimateCreditor | [optional]
+**debtor_name** | Option<**String**> | debtorName | [optional]
+**debtor_account** | Option<[**models::AccountSchema**](AccountSchema.md)> | debtorAccount | [optional]
+**ultimate_debtor** | Option<**String**> | ultimateDebtor | [optional]
+**remittance_information_unstructured** | Option<**String**> | remittanceInformationUnstructured | [optional]
+**remittance_information_unstructured_array** | Option<**Vec<String>**> | remittanceInformationUnstructuredArray | [optional]
+**remittance_information_structured** | Option<**String**> | remittanceInformationStructured | [optional]
+**remittance_information_structured_array** | Option<**Vec<String>**> | remittanceInformationStructuredArray | [optional]
+**additional_information** | Option<**String**> | additionalInformation | [optional]
+**purpose_code** | Option<**String**> | purposeCode | [optional]
+**bank_transaction_code** | Option<**String**> | bankTransactionCode | [optional]
+**proprietary_bank_transaction_code** | Option<**String**> | proprietaryBankTransactionCode | [optional]
+**internal_transaction_id** | Option<**String**> | internalTransactionId | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+