Package app.cybrid.cybrid_api_bank.client.api

Class BanksBankApi

java.lang.Object

app.cybrid.cybrid_api_bank.client.api.BanksBankApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-29T12:48:24.108931Z[Etc/UTC]")
public class BanksBankApi
extends Object

Constructor Summary

Constructors

Constructor	Description
BanksBankApi()
BanksBankApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<BankBankModel>	createBank(PostBankBankModel postBankBankModel)	Create Bank Creates a bank.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>>	createBankWithHttpInfo(PostBankBankModel postBankBankModel)
ApiClient	getApiClient()
reactor.core.publisher.Mono<BankBankModel>	getBank(String bankGuid)	Get Bank Retrieves a bank.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>>	getBankWithHttpInfo(String bankGuid)
reactor.core.publisher.Mono<BankListBankModel>	listBanks(BigInteger page, BigInteger perPage, String guid)	Get banks list Retrieves a listing of bank.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankListBankModel>>	listBanksWithHttpInfo(BigInteger page, BigInteger perPage, String guid)
void	setApiClient(ApiClient apiClient)
reactor.core.publisher.Mono<BankBankModel>	updateBank(String bankGuid, PatchBankBankModel patchBankBankModel)	Patch Bank Update a bank.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>>	updateBankWithHttpInfo(String bankGuid, PatchBankBankModel patchBankBankModel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BanksBankApi

public BanksBankApi()

BanksBankApi

@Autowired
public BanksBankApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBank

public reactor.core.publisher.Mono<BankBankModel> createBank(PostBankBankModel postBankBankModel)
                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException

Create Bank Creates a bank. ## Bank Type Bank's can be created in either `sandbox` or `production` mode. Sandbox Banks will not transact in real fiat dollars or cryptocurrencies. Via the API, only `sandbox` banks can be created. In order to enable a `production` bank please contact [Support](mailto:support@cybrid.app). ## Attestation Identity Records Attestation Identity Records is a method the Cybrid Platform uses to verify the identity of a Bank's customers. Please see the documentation under the create Identity Record API for more technical detail. This feature must specifically be enabled in the Bank's `features` array by including the `attestation_identity_records` flag. At present, attestation identity records is the supported method for verifying a customer's identity on the platform. Please contact [Support](mailto:support@cybrid.app) to inquire about enabling this option for your Organization. Required scope: **banks:execute**

201 - Bank created

400 - Invalid requests

401 - Unauthorized - Authentication failed, invalid subject

403 - Invalid scope

422 - Unable to process request

Parameters:

postBankBankModel - The postBankBankModel parameter

Returns:

BankBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

createBankWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>> createBankWithHttpInfo(PostBankBankModel postBankBankModel)
                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

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

getBank

public reactor.core.publisher.Mono<BankBankModel> getBank(String bankGuid)
                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException

Get Bank Retrieves a bank. Required scope: **banks:read**

200 - bank found

401 - Unauthorized - Authentication failed, invalid subject

403 - Invalid scope

404 - bank not found

Parameters:

bankGuid - Identifier for the bank.

Returns:

BankBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

getBankWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>> getBankWithHttpInfo(String bankGuid)
                                                                                                        throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

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

listBanks

public reactor.core.publisher.Mono<BankListBankModel> listBanks(BigInteger page,
                                                                BigInteger perPage,
                                                                String guid)
                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException

Get banks list Retrieves a listing of bank. Required scope: **banks:read**

200 - get list of banks

401 - Unauthorized - invalid subject, Authentication failed

403 - Invalid scope

Parameters:

page - The page index to retrieve.

perPage - The number of entities per page to return.

guid - Comma separated bank_guids to list banks for.

Returns:

BankListBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

listBanksWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankListBankModel>> listBanksWithHttpInfo(BigInteger page,
                                                                                                                     BigInteger perPage,
                                                                                                                     String guid)
                                                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

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

updateBank

public reactor.core.publisher.Mono<BankBankModel> updateBank(String bankGuid,
                                                             PatchBankBankModel patchBankBankModel)
                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException

Patch Bank Update a bank. Required scope: **banks:write**

200 - bank found

401 - Unauthorized - Authentication failed, invalid subject

403 - Invalid scope

404 - bank not found

Parameters:

bankGuid - Identifier for the bank.

patchBankBankModel - The patchBankBankModel parameter

Returns:

BankBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

updateBankWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BankBankModel>> updateBankWithHttpInfo(String bankGuid,
                                                                                                                  PatchBankBankModel patchBankBankModel)
                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

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