=begin #Cybrid Bank API ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). **⚠️ Never share your Client ID or Secret publicly or in your source code repository.** Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"\", \"client_secret\": \"\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` **⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.** ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer. The version of the OpenAPI document: v0.57.13 Contact: support@cybrid.app Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.0.0 =end require 'cgi' module CybridApiBank class BanksBankApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # 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). ## Backstopped Funding Source A Backstopped Funding Source is an agreement between the Organization and Cybrid on transaction settlement. A Backstopped Funding Source is an escrow bank account that the Organization tops up on a regular basis and is drawn down by the Cybrid Platform when trades are executed by the Bank for its customers. This feature must specifically be enabled in the Bank's `features` array by including the `backstopped_funding_source` flag. To allow customers to trade in a bank that has a Backstopped Funding Source the customer's `fiat` account must be topped up using a `book transfer` prior to executing any trades. Please contact [Support](mailto:support@cybrid.app) to inquire about enabling this option for your Organization. ## Plaid Funding Source A Plaid Funding Source allows customers to directly connect their TradFi bank accounts to the Cybrid platform. This feature must specifically be enabled in the Bank's `features` array by including the `plaid_funding_source` flag. To allow customers to trade in a bank that has a Plaid Funding Source the customer's `fiat` account must first be connected to the platform using Cybrid's `Workflows` and `ExternalBankAccounts` APIs. Once their `ExternalBankAccount` is created on the Cybrid Platform their `fiat` account must be topped up using a `funding` transfer prior to executing any trades. ## 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** # @param post_bank_bank_model [PostBankBankModel] # @param [Hash] opts the optional parameters # @return [BankBankModel] def create_bank(post_bank_bank_model, opts = {}) data, _status_code, _headers = create_bank_with_http_info(post_bank_bank_model, opts) data end # 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). ## Backstopped Funding Source A Backstopped Funding Source is an agreement between the Organization and Cybrid on transaction settlement. A Backstopped Funding Source is an escrow bank account that the Organization tops up on a regular basis and is drawn down by the Cybrid Platform when trades are executed by the Bank for its customers. This feature must specifically be enabled in the Bank's `features` array by including the `backstopped_funding_source` flag. To allow customers to trade in a bank that has a Backstopped Funding Source the customer's `fiat` account must be topped up using a `book transfer` prior to executing any trades. Please contact [Support](mailto:support@cybrid.app) to inquire about enabling this option for your Organization. ## Plaid Funding Source A Plaid Funding Source allows customers to directly connect their TradFi bank accounts to the Cybrid platform. This feature must specifically be enabled in the Bank's `features` array by including the `plaid_funding_source` flag. To allow customers to trade in a bank that has a Plaid Funding Source the customer's `fiat` account must first be connected to the platform using Cybrid's `Workflows` and `ExternalBankAccounts` APIs. Once their `ExternalBankAccount` is created on the Cybrid Platform their `fiat` account must be topped up using a `funding` transfer prior to executing any trades. ## 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** # @param post_bank_bank_model [PostBankBankModel] # @param [Hash] opts the optional parameters # @return [Array<(BankBankModel, Integer, Hash)>] BankBankModel data, response status code and response headers def create_bank_with_http_info(post_bank_bank_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BanksBankApi.create_bank ...' end # verify the required parameter 'post_bank_bank_model' is set if @api_client.config.client_side_validation && post_bank_bank_model.nil? fail ArgumentError, "Missing the required parameter 'post_bank_bank_model' when calling BanksBankApi.create_bank" end # resource path local_var_path = '/api/banks' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(post_bank_bank_model) # return_type return_type = opts[:debug_return_type] || 'BankBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"BanksBankApi.create_bank", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BanksBankApi#create_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get Bank # Retrieves a bank. Required scope: **banks:read** # @param bank_guid [String] Identifier for the bank. # @param [Hash] opts the optional parameters # @return [BankBankModel] def get_bank(bank_guid, opts = {}) data, _status_code, _headers = get_bank_with_http_info(bank_guid, opts) data end # Get Bank # Retrieves a bank. Required scope: **banks:read** # @param bank_guid [String] Identifier for the bank. # @param [Hash] opts the optional parameters # @return [Array<(BankBankModel, Integer, Hash)>] BankBankModel data, response status code and response headers def get_bank_with_http_info(bank_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BanksBankApi.get_bank ...' end # verify the required parameter 'bank_guid' is set if @api_client.config.client_side_validation && bank_guid.nil? fail ArgumentError, "Missing the required parameter 'bank_guid' when calling BanksBankApi.get_bank" end # resource path local_var_path = '/api/banks/{bank_guid}'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'BankBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"BanksBankApi.get_bank", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BanksBankApi#get_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get banks list # Retrieves a listing of bank. Required scope: **banks:read** # @param [Hash] opts the optional parameters # @option opts [Integer] :page The page index to retrieve. # @option opts [Integer] :per_page The number of entities per page to return. # @option opts [String] :guid Comma separated bank_guids to list banks for. # @return [BankListBankModel] def list_banks(opts = {}) data, _status_code, _headers = list_banks_with_http_info(opts) data end # Get banks list # Retrieves a listing of bank. Required scope: **banks:read** # @param [Hash] opts the optional parameters # @option opts [Integer] :page The page index to retrieve. # @option opts [Integer] :per_page The number of entities per page to return. # @option opts [String] :guid Comma separated bank_guids to list banks for. # @return [Array<(BankListBankModel, Integer, Hash)>] BankListBankModel data, response status code and response headers def list_banks_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BanksBankApi.list_banks ...' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling BanksBankApi.list_banks, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling BanksBankApi.list_banks, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling BanksBankApi.list_banks, must be greater than or equal to 1.' end # resource path local_var_path = '/api/banks' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'BankListBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"BanksBankApi.list_banks", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BanksBankApi#list_banks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Patch Bank # Update a bank. Required scope: **banks:write** # @param bank_guid [String] Identifier for the bank. # @param patch_bank_bank_model [PatchBankBankModel] # @param [Hash] opts the optional parameters # @return [BankBankModel] def update_bank(bank_guid, patch_bank_bank_model, opts = {}) data, _status_code, _headers = update_bank_with_http_info(bank_guid, patch_bank_bank_model, opts) data end # Patch Bank # Update a bank. Required scope: **banks:write** # @param bank_guid [String] Identifier for the bank. # @param patch_bank_bank_model [PatchBankBankModel] # @param [Hash] opts the optional parameters # @return [Array<(BankBankModel, Integer, Hash)>] BankBankModel data, response status code and response headers def update_bank_with_http_info(bank_guid, patch_bank_bank_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BanksBankApi.update_bank ...' end # verify the required parameter 'bank_guid' is set if @api_client.config.client_side_validation && bank_guid.nil? fail ArgumentError, "Missing the required parameter 'bank_guid' when calling BanksBankApi.update_bank" end # verify the required parameter 'patch_bank_bank_model' is set if @api_client.config.client_side_validation && patch_bank_bank_model.nil? fail ArgumentError, "Missing the required parameter 'patch_bank_bank_model' when calling BanksBankApi.update_bank" end # resource path local_var_path = '/api/banks/{bank_guid}'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_bank_bank_model) # return_type return_type = opts[:debug_return_type] || 'BankBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"BanksBankApi.update_bank", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BanksBankApi#update_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end