Package app.cybrid.cybrid_api_bank.client.api

Class ExternalBankAccountsBankApi

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-07-12T15:31:03.637994Z[Etc/UTC]")
public class ExternalBankAccountsBankApi
extends Object

    • Constructor Detail

      • ExternalBankAccountsBankApi

        public ExternalBankAccountsBankApi()

      • ExternalBankAccountsBankApi

        @Autowired
public ExternalBankAccountsBankApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createExternalBankAccount

        public reactor.core.publisher.Mono<ExternalBankAccountBankModel> createExternalBankAccount​(PostExternalBankAccountBankModel postExternalBankAccountBankModel)
                                                                                    throws org.springframework.web.reactive.function.client.WebClientResponseException
        Create ExternalBankAccount Create an ExternalBankAccount. ## Account creation Accounts can be created for a Bank or a Customer. To create accounts for your Bank, omit the `customer_guid` parameter in the request body. To create accounts for your Customers, include the `customer_guid` parameter in the request body. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the external bank account details in our private store | | completed | The Platform has created the external bank account | | unverified | The external bank account is created, but it has not yet been verified | | failed | The Platform was not able to successfully create the external bank account | | refresh_required | The Platform has created the external bank account, but needs to be refreshed | | deleting | The Platform is deleting the external bank account | | deleted | The Platform has deleted the external bank account | ## Failure codes | Code | Description | |------|-------------| | invalid_routing_number | The provided routing number is invalid | | refresh_required | The Plaid processor token used to create the account needs to be refreshed | | plaid_processor_token | An account could not be created due to an invalid Plaid processor token or an error with Plaid | Required scope: **external_bank_accounts:execute**

        201 - ExternalBankAccount created

        400 - Invalid requests

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        422 - Unable to process request

        Parameters:
        postExternalBankAccountBankModel - The postExternalBankAccountBankModel parameter
        Returns:
        ExternalBankAccountBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • createExternalBankAccountWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ExternalBankAccountBankModel>> createExternalBankAccountWithHttpInfo​(PostExternalBankAccountBankModel postExternalBankAccountBankModel)
                                                                                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException

      • deleteExternalBankAccount

        public reactor.core.publisher.Mono<ExternalBankAccountBankModel> deleteExternalBankAccount​(String externalBankAccountGuid)
                                                                                    throws org.springframework.web.reactive.function.client.WebClientResponseException
        Delete External Bank Account Deletes an external bank account. Required scope: **external_bank_accounts:execute**

        200 - External bank account deleted

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - ExternalBankAccount not found

        Parameters:
        externalBankAccountGuid - Identifier for the external bank account.
        Returns:
        ExternalBankAccountBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • deleteExternalBankAccountWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ExternalBankAccountBankModel>> deleteExternalBankAccountWithHttpInfo​(String externalBankAccountGuid)
                                                                                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException

      • getExternalBankAccount

        public reactor.core.publisher.Mono<ExternalBankAccountBankModel> getExternalBankAccount​(String externalBankAccountGuid,
                                                                                        Boolean forceBalanceRefresh,
                                                                                        Boolean includeBalances,
                                                                                        Boolean includePii)
                                                                                 throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get External Bank Account Retrieves an external bank account. Required scope: **external_bank_accounts:read**

        200 - External bank account found

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - ExternalBankAccount not found

        422 - Unable to process request

        Parameters:
        externalBankAccountGuid - Identifier for the external bank account.
        forceBalanceRefresh - Force the balance on the account to be retrieved.
        includeBalances - Include balance information in the response. If `force_balance_refresh` is `true`, the most up to date balance will be returned. If `force_balance_refresh` is `false`, the cached balance will be returned. `balance_updated_at` in the response will provide the timestamp the balance was last updated.
        includePii - Include the account holder's PII in the response.
        Returns:
        ExternalBankAccountBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • getExternalBankAccountWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ExternalBankAccountBankModel>> getExternalBankAccountWithHttpInfo​(String externalBankAccountGuid,
                                                                                                                                             Boolean forceBalanceRefresh,
                                                                                                                                             Boolean includeBalances,
                                                                                                                                             Boolean includePii)
                                                                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException

      • listExternalBankAccounts

        public reactor.core.publisher.Mono<ExternalBankAccountListBankModel> listExternalBankAccounts​(BigInteger page,
                                                                                              BigInteger perPage,
                                                                                              String guid,
                                                                                              String bankGuid,
                                                                                              String customerGuid,
                                                                                              String asset,
                                                                                              String state)
                                                                                       throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get external bank accounts list Retrieves a listing of external bank accounts. Required scope: **external_bank_accounts:read**

        200 - Get list of external_bank_accounts

        400 - Invalid requests

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        Parameters:
        page - The page index to retrieve.
        perPage - The number of entities per page to return.
        guid - Comma separated external_bank_account_guids to list external_bank_accounts for.
        bankGuid - Comma separated bank_guids to list external_bank_accounts for.
        customerGuid - Comma separated customer_guids to list external_bank_accounts for.
        asset - Comma separated assets to list external_bank_accounts for.
        state - Comma separated states to list external_bank_accounts for.
        Returns:
        ExternalBankAccountListBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • listExternalBankAccountsWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ExternalBankAccountListBankModel>> listExternalBankAccountsWithHttpInfo​(BigInteger page,
                                                                                                                                                   BigInteger perPage,
                                                                                                                                                   String guid,
                                                                                                                                                   String bankGuid,
                                                                                                                                                   String customerGuid,
                                                                                                                                                   String asset,
                                                                                                                                                   String state)
                                                                                                                                            throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException

      • patchExternalBankAccount

        public reactor.core.publisher.Mono<ExternalBankAccountBankModel> patchExternalBankAccount​(String externalBankAccountGuid,
                                                                                          PatchExternalBankAccountBankModel patchExternalBankAccountBankModel)
                                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException
        Patch ExternalBankAccount Patch an external bank account. Required scope: **external_bank_accounts:write**

        200 - external bank account found

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - ExternalBankAccount not found

        Parameters:
        externalBankAccountGuid - Identifier for the external bank account.
        patchExternalBankAccountBankModel - The patchExternalBankAccountBankModel parameter
        Returns:
        ExternalBankAccountBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • patchExternalBankAccountWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ExternalBankAccountBankModel>> patchExternalBankAccountWithHttpInfo​(String externalBankAccountGuid,
                                                                                                                                               PatchExternalBankAccountBankModel patchExternalBankAccountBankModel)
                                                                                                                                        throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException