java.lang.Object
- app.cybrid.cybrid_api_bank.client.api.TransfersBankApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-04-09T12:24:50.980872Z[Etc/UTC]")
public class TransfersBankApi
extends Object

Constructor Summary

Constructors
Constructor Description

TransfersBankApi()

TransfersBankApi(ApiClient apiClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`reactor.core.publisher.Mono<TransferBankModel>`	`createTransfer(PostTransferBankModel postTransferBankModel)`	Create Transfer Creates a transfer.
`reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<TransferBankModel>>`	`createTransferWithHttpInfo(PostTransferBankModel postTransferBankModel)`
`ApiClient`	`getApiClient()`
`reactor.core.publisher.Mono<TransferBankModel>`	`getTransfer(String transferGuid)`	Get Transfer Retrieves a transfer.
`reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<TransferBankModel>>`	`getTransferWithHttpInfo(String transferGuid)`
`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 createdAtGte, String createdAtLt, String updatedAtGte, String updatedAtLt)`	Get transfers list Retrieves a listing of transfers.
`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 createdAtGte, String createdAtLt, String updatedAtGte, String updatedAtLt)`
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 | |------|-------------| | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid | | 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 | | compliance_rejection | The transfer was rejected for compliance reasons | | cancelled | The transfer was manually cancelled | | reversed | The transfer was reversed | | 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 | | amount_too_low | The transfer was rejected due to the amount being too low | Required scope: **transfers:execute**
201 - Transfer created
400 - Bad Request
409 - Conflict
422 - Unprocessable Entity
401 - Unauthorized - Authentication failed,
403 - Invalid scope

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 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.; 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 createdAtGte,
                                                                                                                             String createdAtLt,
                                                                                                                             String updatedAtGte,
                                                                                                                             String updatedAtLt)
                                                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:: org.springframework.web.reactive.function.client.WebClientResponseException

Class TransfersBankApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransfersBankApi

TransfersBankApi

Method Detail

getApiClient

setApiClient

createTransfer

createTransferWithHttpInfo

getTransfer

getTransferWithHttpInfo

listTransfers

listTransfersWithHttpInfo