Package app.cybrid.cybrid_api_bank.client.api

Class TransfersBankApi

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-06T18:09:34.634307Z[Etc/UTC]")
public class TransfersBankApi
extends Object

    • Constructor Detail

      • TransfersBankApi

        public TransfersBankApi()

      • TransfersBankApi

        @Autowired
public TransfersBankApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createTransfer

        public reactor.core.publisher.Mono<TransferBankModel> createTransfer​(PostTransferBankModel postTransferBankModel)
                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException
        Create Transfer Creates a transfer. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the trade details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |------|-------------| | amount_too_low | The transfer was rejected due to the amount being too low | | cancelled | The transfer was manually cancelled | | compliance_rejection | The transfer was rejected for compliance reasons | | internal_error | An internal error occurred while processing the transfer, please try again | | invalid_address | The destination address is invalid for transfer | | invalid_balance | There was insufficient balance at the lightning provider to complete the transfer | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | network_fee_too_low | The transfer was rejected due to the network fee being too low | | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | party_name_invalid | The transfer's associated external bank account has an invalid party name | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | | plaid_access_not_granted | See the description from Plaid [here](https://plaid.com/docs/errors/item/#access_not_granted) | | plaid_institution_not_responding | See the description from Plaid [here](https://plaid.com/docs/errors/institution/#institution_not_responding) | | plaid_internal_server_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error) | | plaid_item_not_found | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_found) | | plaid_item_not_supported | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_supported) | | plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. | | plaid_no_accounts | See the description from Plaid [here](https://plaid.com/docs/errors/item/#no_accounts) | | plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid | | plaid_unknown_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#unknown_error) | | refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid | | reversed | The transfer was reversed | ## Failure codes that will result in a state change for the associated external bank account | Code | Description | |------|-------------| | refresh_required | The transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state `refresh_required` | | plaid_access_not_granted | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_found | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_supported | The transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state `deleted` | | plaid_multiple_accounts | The transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state `deleted` | | plaid_no_accounts | The transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state `deleted` | Required scope: **transfers:execute**

        201 - Transfer created

        401 - Unauthorized

        403 - Forbidden

        409 - Conflict

        422 - Unprocessable Content

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

      • createTransferWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<TransferBankModel>> createTransferWithHttpInfo​(PostTransferBankModel postTransferBankModel)
                                                                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException

      • getTransfer

        public reactor.core.publisher.Mono<TransferBankModel> getTransfer​(String transferGuid)
                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get Transfer Retrieves a transfer. Required scope: **transfers:read**

        200 - transfer found

        401 - Unauthorized - Authentication failed,

        403 - Invalid scope

        404 - transfer not found

        Parameters:
        transferGuid - Identifier for the transfer.
        Returns:
        TransferBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • getTransferWithHttpInfo

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

      • listTransfers

        public reactor.core.publisher.Mono<TransferListBankModel> listTransfers​(BigInteger page,
                                                                        BigInteger perPage,
                                                                        String guid,
                                                                        String transferType,
                                                                        String bankGuid,
                                                                        String customerGuid,
                                                                        String accountGuid,
                                                                        String state,
                                                                        String side,
                                                                        String label,
                                                                        String txnHash,
                                                                        String createdAtGte,
                                                                        String createdAtLt,
                                                                        String updatedAtGte,
                                                                        String updatedAtLt)
                                                                 throws org.springframework.web.reactive.function.client.WebClientResponseException
        Get transfers list Retrieves a listing of transfers. Required scope: **transfers:read**

        200 - get list of transfers

        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 transfer_guids to list transfers for.
        transferType - Comma separated transfer_types to list accounts for.
        bankGuid - Comma separated bank_guids to list transfers for.
        customerGuid - Comma separated customer_guids to list transfers for.
        accountGuid - Comma separated account_guids to list transfers for.
        state - Comma separated states to list transfers for.
        side - Comma separated sides to list transfers for.
        label - Comma separated labels to list transfers for.
        txnHash - Comma separated transaction hashes to list transfers for.
        createdAtGte - Created at start date inclusive lower bound, ISO8601
        createdAtLt - Created at end date exclusive upper bound, ISO8601.
        updatedAtGte - Created at start date inclusive lower bound, ISO8601
        updatedAtLt - Created at end date exclusive upper bound, ISO8601.
        Returns:
        TransferListBankModel
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

      • listTransfersWithHttpInfo

        public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<TransferListBankModel>> listTransfersWithHttpInfo​(BigInteger page,
                                                                                                                             BigInteger perPage,
                                                                                                                             String guid,
                                                                                                                             String transferType,
                                                                                                                             String bankGuid,
                                                                                                                             String customerGuid,
                                                                                                                             String accountGuid,
                                                                                                                             String state,
                                                                                                                             String side,
                                                                                                                             String label,
                                                                                                                             String txnHash,
                                                                                                                             String createdAtGte,
                                                                                                                             String createdAtLt,
                                                                                                                             String updatedAtGte,
                                                                                                                             String updatedAtLt)
                                                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException
        Throws:
        org.springframework.web.reactive.function.client.WebClientResponseException