cybrid_api_bank_ruby 0.30.28 → 0.30.34
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +5 -5
- data/cybrid_api_bank_ruby.gemspec +1 -1
- data/docs/AccountsBankApi.md +2 -2
- data/docs/AssetsBankApi.md +2 -2
- data/docs/BanksBankApi.md +2 -2
- data/docs/CustomersBankApi.md +2 -2
- data/docs/IdentityRecordsBankApi.md +2 -2
- data/docs/QuotesBankApi.md +2 -2
- data/docs/TradesBankApi.md +2 -2
- data/docs/TradingConfigurationsBankApi.md +2 -2
- data/docs/VerificationKeysBankApi.md +2 -2
- data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +5 -5
- data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
- data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/cybrid_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_settlement_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_settlement_expected_payment_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_settlement_obligation_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/exchange_settlement_payment_order_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_trading_configuration_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/system_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trading_configuration_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trading_configuration_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/version.rb +2 -2
- data/lib/cybrid_api_bank_ruby.rb +1 -1
- data/spec/api/accounts_bank_api_spec.rb +1 -1
- data/spec/api/assets_bank_api_spec.rb +1 -1
- data/spec/api/banks_bank_api_spec.rb +1 -1
- data/spec/api/customers_bank_api_spec.rb +1 -1
- data/spec/api/identity_records_bank_api_spec.rb +1 -1
- data/spec/api/prices_bank_api_spec.rb +1 -1
- data/spec/api/quotes_bank_api_spec.rb +1 -1
- data/spec/api/symbols_bank_api_spec.rb +1 -1
- data/spec/api/trades_bank_api_spec.rb +1 -1
- data/spec/api/trading_configurations_bank_api_spec.rb +1 -1
- data/spec/api/verification_keys_bank_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_bank_model_spec.rb +1 -1
- data/spec/models/account_list_bank_model_spec.rb +1 -1
- data/spec/models/asset_bank_model_spec.rb +1 -1
- data/spec/models/asset_list_bank_model_spec.rb +1 -1
- data/spec/models/attestation_details_bank_model_spec.rb +1 -1
- data/spec/models/bank_bank_model_spec.rb +1 -1
- data/spec/models/bank_list_bank_model_spec.rb +1 -1
- data/spec/models/customer_bank_model_spec.rb +1 -1
- data/spec/models/customer_list_bank_model_spec.rb +1 -1
- data/spec/models/cybrid_account_bank_model_spec.rb +1 -1
- data/spec/models/error_response_bank_model_spec.rb +1 -1
- data/spec/models/exchange_account_bank_model_spec.rb +1 -1
- data/spec/models/exchange_bank_model_spec.rb +1 -1
- data/spec/models/exchange_list_bank_model_spec.rb +1 -1
- data/spec/models/exchange_settlement_bank_model_spec.rb +1 -1
- data/spec/models/exchange_settlement_expected_payment_bank_model_spec.rb +1 -1
- data/spec/models/exchange_settlement_obligation_bank_model_spec.rb +1 -1
- data/spec/models/exchange_settlement_payment_order_bank_model_spec.rb +1 -1
- data/spec/models/fee_bank_model_spec.rb +1 -1
- data/spec/models/identity_record_bank_model_spec.rb +1 -1
- data/spec/models/identity_record_list_bank_model_spec.rb +1 -1
- data/spec/models/post_account_bank_model_spec.rb +1 -1
- data/spec/models/post_bank_bank_model_spec.rb +1 -1
- data/spec/models/post_customer_bank_model_spec.rb +1 -1
- data/spec/models/post_fee_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_record_bank_model_spec.rb +1 -1
- data/spec/models/post_quote_bank_model_spec.rb +1 -1
- data/spec/models/post_trade_bank_model_spec.rb +1 -1
- data/spec/models/post_trading_configuration_bank_model_spec.rb +1 -1
- data/spec/models/post_verification_key_bank_model_spec.rb +1 -1
- data/spec/models/quote_bank_model_spec.rb +1 -1
- data/spec/models/quote_list_bank_model_spec.rb +1 -1
- data/spec/models/symbol_price_bank_model_spec.rb +1 -1
- data/spec/models/system_account_bank_model_spec.rb +1 -1
- data/spec/models/trade_bank_model_spec.rb +1 -1
- data/spec/models/trade_list_bank_model_spec.rb +1 -1
- data/spec/models/trading_configuration_bank_model_spec.rb +1 -1
- data/spec/models/trading_configuration_list_bank_model_spec.rb +1 -1
- data/spec/models/verification_key_bank_model_spec.rb +1 -1
- data/spec/models/verification_key_list_bank_model_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/jaro_winkler-1.5.4/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.4/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/Makefile +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d4d790cfea099045f2b075e05028ad3357fd2d87d1b72f59387420048fe0ef9d
|
|
4
|
+
data.tar.gz: c3cd796ec15f51b5ab43d40a1b883bf6588a16a7f972befecbda23a4c943d80c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4e4065bd4f1d5df577c9d401c1971ed4141e9733f01a537cf509e0fbda1af5dd5293e4ee20f54402d540f0f27b8f4c1600e8dabaf24d3e7c01131dbf21e77db2
|
|
7
|
+
data.tar.gz: 624ad5b8bbfcbe134bf9d9e43bc9c23a65c5b35e9f9e131fece85ca9d597156bdfcb720e8c51caea98e1c1319961e5699cb807e00bfbd4964156bf4497f465b9
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -82,8 +82,8 @@ Customers must also have an account to be able to transact. See the Accounts API
|
|
|
82
82
|
|
|
83
83
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
84
84
|
|
|
85
|
-
- API version: v0.30.
|
|
86
|
-
- Package version: 0.30.
|
|
85
|
+
- API version: v0.30.34
|
|
86
|
+
- Package version: 0.30.34
|
|
87
87
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
88
88
|
|
|
89
89
|
## Installation
|
|
@@ -99,16 +99,16 @@ gem build cybrid_api_bank_ruby.gemspec
|
|
|
99
99
|
Then either install the gem locally:
|
|
100
100
|
|
|
101
101
|
```shell
|
|
102
|
-
gem install ./cybrid_api_bank_ruby-0.30.
|
|
102
|
+
gem install ./cybrid_api_bank_ruby-0.30.34.gem
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
-
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.30.
|
|
105
|
+
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.30.34.gem` to install the development dependencies)
|
|
106
106
|
|
|
107
107
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
108
108
|
|
|
109
109
|
Finally add this to the Gemfile:
|
|
110
110
|
|
|
111
|
-
gem 'cybrid_api_bank_ruby', '~> 0.30.
|
|
111
|
+
gem 'cybrid_api_bank_ruby', '~> 0.30.34'
|
|
112
112
|
|
|
113
113
|
### Install from Git
|
|
114
114
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: v0.30.
|
|
8
|
+
The version of the OpenAPI document: v0.30.34
|
|
9
9
|
Contact: support@cybrid.app
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
OpenAPI Generator version: 6.0.0
|
data/docs/AccountsBankApi.md
CHANGED
|
@@ -215,8 +215,8 @@ end
|
|
|
215
215
|
|
|
216
216
|
| Name | Type | Description | Notes |
|
|
217
217
|
| ---- | ---- | ----------- | ----- |
|
|
218
|
-
| **page** | **Integer** | The page index to retrieve. | [optional]
|
|
219
|
-
| **per_page** | **Integer** | The number of entities per page to return. | [optional]
|
|
218
|
+
| **page** | **Integer** | The page index to retrieve. | [optional] |
|
|
219
|
+
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
|
|
220
220
|
| **guid** | **String** | Comma separated account_guids to list accounts for. | [optional] |
|
|
221
221
|
| **bank_guid** | **String** | Comma separated bank_guids to list accounts for. | [optional] |
|
|
222
222
|
| **customer_guid** | **String** | Comma separated customer_guids to list accounts for. | [optional] |
|
data/docs/AssetsBankApi.md
CHANGED
|
@@ -66,8 +66,8 @@ end
|
|
|
66
66
|
|
|
67
67
|
| Name | Type | Description | Notes |
|
|
68
68
|
| ---- | ---- | ----------- | ----- |
|
|
69
|
-
| **page** | **Integer** | The page index to retrieve. | [optional]
|
|
70
|
-
| **per_page** | **Integer** | The number of entities per page to return. | [optional]
|
|
69
|
+
| **page** | **Integer** | The page index to retrieve. | [optional] |
|
|
70
|
+
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
|
|
71
71
|
|
|
72
72
|
### Return type
|
|
73
73
|
|
data/docs/BanksBankApi.md
CHANGED
|
@@ -213,8 +213,8 @@ end
|
|
|
213
213
|
|
|
214
214
|
| Name | Type | Description | Notes |
|
|
215
215
|
| ---- | ---- | ----------- | ----- |
|
|
216
|
-
| **page** | **Integer** | The page index to retrieve. | [optional]
|
|
217
|
-
| **per_page** | **Integer** | The number of entities per page to return. | [optional]
|
|
216
|
+
| **page** | **Integer** | The page index to retrieve. | [optional] |
|
|
217
|
+
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
|
|
218
218
|
| **guid** | **String** | Comma separated bank_guids to list banks for. | [optional] |
|
|
219
219
|
|
|
220
220
|
### Return type
|
data/docs/CustomersBankApi.md
CHANGED
|
@@ -214,8 +214,8 @@ end
|
|
|
214
214
|
|
|
215
215
|
| Name | Type | Description | Notes |
|
|
216
216
|
| ---- | ---- | ----------- | ----- |
|
|
217
|
-
| **page** | **Integer** | | [optional]
|
|
218
|
-
| **per_page** | **Integer** | | [optional]
|
|
217
|
+
| **page** | **Integer** | | [optional] |
|
|
218
|
+
| **per_page** | **Integer** | | [optional] |
|
|
219
219
|
| **bank_guid** | **String** | Comma separated bank_guids to list customers for. | [optional] |
|
|
220
220
|
| **guid** | **String** | Comma separated customer_guids to list customers for. | [optional] |
|
|
221
221
|
|
|
@@ -214,8 +214,8 @@ end
|
|
|
214
214
|
| Name | Type | Description | Notes |
|
|
215
215
|
| ---- | ---- | ----------- | ----- |
|
|
216
216
|
| **customer_guid** | **String** | Comma separated customer identifier to list identity records for. | [optional] |
|
|
217
|
-
| **page** | **Integer** | | [optional]
|
|
218
|
-
| **per_page** | **Integer** | | [optional]
|
|
217
|
+
| **page** | **Integer** | | [optional] |
|
|
218
|
+
| **per_page** | **Integer** | | [optional] |
|
|
219
219
|
|
|
220
220
|
### Return type
|
|
221
221
|
|
data/docs/QuotesBankApi.md
CHANGED
|
@@ -215,8 +215,8 @@ end
|
|
|
215
215
|
|
|
216
216
|
| Name | Type | Description | Notes |
|
|
217
217
|
| ---- | ---- | ----------- | ----- |
|
|
218
|
-
| **page** | **Integer** | | [optional]
|
|
219
|
-
| **per_page** | **Integer** | | [optional]
|
|
218
|
+
| **page** | **Integer** | | [optional] |
|
|
219
|
+
| **per_page** | **Integer** | | [optional] |
|
|
220
220
|
| **guid** | **String** | Comma separated quote_guids to list quotes for. | [optional] |
|
|
221
221
|
| **bank_guid** | **String** | Comma separated bank_guids to list quotes for. | [optional] |
|
|
222
222
|
| **customer_guid** | **String** | Comma separated customer_guids to list quotes for. | [optional] |
|
data/docs/TradesBankApi.md
CHANGED
|
@@ -216,8 +216,8 @@ end
|
|
|
216
216
|
|
|
217
217
|
| Name | Type | Description | Notes |
|
|
218
218
|
| ---- | ---- | ----------- | ----- |
|
|
219
|
-
| **page** | **Integer** | The page index to retrieve. | [optional]
|
|
220
|
-
| **per_page** | **Integer** | The number of entities per page to return. | [optional]
|
|
219
|
+
| **page** | **Integer** | The page index to retrieve. | [optional] |
|
|
220
|
+
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
|
|
221
221
|
| **guid** | **String** | Comma separated trade_guids to list trades for. | [optional] |
|
|
222
222
|
| **bank_guid** | **String** | Comma separated bank_guids to list trades for. | [optional] |
|
|
223
223
|
| **customer_guid** | **String** | Comma separated customer_guids to list trades for. | [optional] |
|
|
@@ -212,8 +212,8 @@ end
|
|
|
212
212
|
|
|
213
213
|
| Name | Type | Description | Notes |
|
|
214
214
|
| ---- | ---- | ----------- | ----- |
|
|
215
|
-
| **page** | **Integer** | | [optional]
|
|
216
|
-
| **per_page** | **Integer** | | [optional]
|
|
215
|
+
| **page** | **Integer** | | [optional] |
|
|
216
|
+
| **per_page** | **Integer** | | [optional] |
|
|
217
217
|
|
|
218
218
|
### Return type
|
|
219
219
|
|
|
@@ -212,8 +212,8 @@ end
|
|
|
212
212
|
|
|
213
213
|
| Name | Type | Description | Notes |
|
|
214
214
|
| ---- | ---- | ----------- | ----- |
|
|
215
|
-
| **page** | **Integer** | | [optional]
|
|
216
|
-
| **per_page** | **Integer** | | [optional]
|
|
215
|
+
| **page** | **Integer** | | [optional] |
|
|
216
|
+
| **per_page** | **Integer** | | [optional] |
|
|
217
217
|
|
|
218
218
|
### Return type
|
|
219
219
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# List Accounts
|
|
154
154
|
# Retrieves a list of accounts. Required scope: **accounts:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
156
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
158
158
|
# @option opts [String] :guid Comma separated account_guids to list accounts for.
|
|
159
159
|
# @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.
|
|
160
160
|
# @option opts [String] :customer_guid Comma separated customer_guids to list accounts for.
|
|
@@ -167,8 +167,8 @@ module CybridApiBank
|
|
|
167
167
|
# List Accounts
|
|
168
168
|
# Retrieves a list of accounts. Required scope: **accounts:read**
|
|
169
169
|
# @param [Hash] opts the optional parameters
|
|
170
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
171
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
170
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
171
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
172
172
|
# @option opts [String] :guid Comma separated account_guids to list accounts for.
|
|
173
173
|
# @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.
|
|
174
174
|
# @option opts [String] :customer_guid Comma separated customer_guids to list accounts for.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -22,8 +22,8 @@ module CybridApiBank
|
|
|
22
22
|
# Get assets list
|
|
23
23
|
# Retrieves a listing of assets. Required scope: **prices:read**
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
26
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
25
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
26
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
27
27
|
# @return [AssetListBankModel]
|
|
28
28
|
def list_assets(opts = {})
|
|
29
29
|
data, _status_code, _headers = list_assets_with_http_info(opts)
|
|
@@ -33,8 +33,8 @@ module CybridApiBank
|
|
|
33
33
|
# Get assets list
|
|
34
34
|
# Retrieves a listing of assets. Required scope: **prices:read**
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
37
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
36
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
37
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
38
38
|
# @return [Array<(AssetListBankModel, Integer, Hash)>] AssetListBankModel data, response status code and response headers
|
|
39
39
|
def list_assets_with_http_info(opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# Get banks list
|
|
154
154
|
# Retrieves a listing of bank. Required scope: **banks:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
156
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
158
158
|
# @option opts [String] :guid Comma separated bank_guids to list banks for.
|
|
159
159
|
# @return [BankListBankModel]
|
|
160
160
|
def list_banks(opts = {})
|
|
@@ -165,8 +165,8 @@ module CybridApiBank
|
|
|
165
165
|
# Get banks list
|
|
166
166
|
# Retrieves a listing of bank. Required scope: **banks:read**
|
|
167
167
|
# @param [Hash] opts the optional parameters
|
|
168
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
169
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
168
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
169
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
170
170
|
# @option opts [String] :guid Comma separated bank_guids to list banks for.
|
|
171
171
|
# @return [Array<(BankListBankModel, Integer, Hash)>] BankListBankModel data, response status code and response headers
|
|
172
172
|
def list_banks_with_http_info(opts = {})
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# Get customers list
|
|
154
154
|
# Retrieves a listing of customers. Required scope: **customers:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page
|
|
157
|
-
# @option opts [Integer] :per_page
|
|
156
|
+
# @option opts [Integer] :page
|
|
157
|
+
# @option opts [Integer] :per_page
|
|
158
158
|
# @option opts [String] :bank_guid Comma separated bank_guids to list customers for.
|
|
159
159
|
# @option opts [String] :guid Comma separated customer_guids to list customers for.
|
|
160
160
|
# @return [CustomerListBankModel]
|
|
@@ -166,8 +166,8 @@ module CybridApiBank
|
|
|
166
166
|
# Get customers list
|
|
167
167
|
# Retrieves a listing of customers. Required scope: **customers:read**
|
|
168
168
|
# @param [Hash] opts the optional parameters
|
|
169
|
-
# @option opts [Integer] :page
|
|
170
|
-
# @option opts [Integer] :per_page
|
|
169
|
+
# @option opts [Integer] :page
|
|
170
|
+
# @option opts [Integer] :per_page
|
|
171
171
|
# @option opts [String] :bank_guid Comma separated bank_guids to list customers for.
|
|
172
172
|
# @option opts [String] :guid Comma separated customer_guids to list customers for.
|
|
173
173
|
# @return [Array<(CustomerListBankModel, Integer, Hash)>] CustomerListBankModel data, response status code and response headers
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -154,8 +154,8 @@ module CybridApiBank
|
|
|
154
154
|
# Retrieves a listing of identity records for a bank. Required scope: **customers:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
156
|
# @option opts [String] :customer_guid Comma separated customer identifier to list identity records for.
|
|
157
|
-
# @option opts [Integer] :page
|
|
158
|
-
# @option opts [Integer] :per_page
|
|
157
|
+
# @option opts [Integer] :page
|
|
158
|
+
# @option opts [Integer] :per_page
|
|
159
159
|
# @return [IdentityRecordListBankModel]
|
|
160
160
|
def list_identity_records(opts = {})
|
|
161
161
|
data, _status_code, _headers = list_identity_records_with_http_info(opts)
|
|
@@ -166,8 +166,8 @@ module CybridApiBank
|
|
|
166
166
|
# Retrieves a listing of identity records for a bank. Required scope: **customers:read**
|
|
167
167
|
# @param [Hash] opts the optional parameters
|
|
168
168
|
# @option opts [String] :customer_guid Comma separated customer identifier to list identity records for.
|
|
169
|
-
# @option opts [Integer] :page
|
|
170
|
-
# @option opts [Integer] :per_page
|
|
169
|
+
# @option opts [Integer] :page
|
|
170
|
+
# @option opts [Integer] :per_page
|
|
171
171
|
# @return [Array<(IdentityRecordListBankModel, Integer, Hash)>] IdentityRecordListBankModel data, response status code and response headers
|
|
172
172
|
def list_identity_records_with_http_info(opts = {})
|
|
173
173
|
if @api_client.config.debugging
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# Get quotes list
|
|
154
154
|
# Retrieves a listing of quotes for all customers of a bank. Required scope: **quotes:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page
|
|
157
|
-
# @option opts [Integer] :per_page
|
|
156
|
+
# @option opts [Integer] :page
|
|
157
|
+
# @option opts [Integer] :per_page
|
|
158
158
|
# @option opts [String] :guid Comma separated quote_guids to list quotes for.
|
|
159
159
|
# @option opts [String] :bank_guid Comma separated bank_guids to list quotes for.
|
|
160
160
|
# @option opts [String] :customer_guid Comma separated customer_guids to list quotes for.
|
|
@@ -167,8 +167,8 @@ module CybridApiBank
|
|
|
167
167
|
# Get quotes list
|
|
168
168
|
# Retrieves a listing of quotes for all customers of a bank. Required scope: **quotes:read**
|
|
169
169
|
# @param [Hash] opts the optional parameters
|
|
170
|
-
# @option opts [Integer] :page
|
|
171
|
-
# @option opts [Integer] :per_page
|
|
170
|
+
# @option opts [Integer] :page
|
|
171
|
+
# @option opts [Integer] :per_page
|
|
172
172
|
# @option opts [String] :guid Comma separated quote_guids to list quotes for.
|
|
173
173
|
# @option opts [String] :bank_guid Comma separated bank_guids to list quotes for.
|
|
174
174
|
# @option opts [String] :customer_guid Comma separated customer_guids to list quotes for.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# Get trades list
|
|
154
154
|
# Retrieves a listing of trades. Required scope: **trades:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
156
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
157
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
158
158
|
# @option opts [String] :guid Comma separated trade_guids to list trades for.
|
|
159
159
|
# @option opts [String] :bank_guid Comma separated bank_guids to list trades for.
|
|
160
160
|
# @option opts [String] :customer_guid Comma separated customer_guids to list trades for.
|
|
@@ -168,8 +168,8 @@ module CybridApiBank
|
|
|
168
168
|
# Get trades list
|
|
169
169
|
# Retrieves a listing of trades. Required scope: **trades:read**
|
|
170
170
|
# @param [Hash] opts the optional parameters
|
|
171
|
-
# @option opts [Integer] :page The page index to retrieve.
|
|
172
|
-
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
171
|
+
# @option opts [Integer] :page The page index to retrieve.
|
|
172
|
+
# @option opts [Integer] :per_page The number of entities per page to return.
|
|
173
173
|
# @option opts [String] :guid Comma separated trade_guids to list trades for.
|
|
174
174
|
# @option opts [String] :bank_guid Comma separated bank_guids to list trades for.
|
|
175
175
|
# @option opts [String] :customer_guid Comma separated customer_guids to list trades for.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v0.30.
|
|
6
|
+
The version of the OpenAPI document: v0.30.34
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -153,8 +153,8 @@ module CybridApiBank
|
|
|
153
153
|
# List trading configurations
|
|
154
154
|
# Retrieves a listing of trading configurations for a bank. Required scope: **banks:read**
|
|
155
155
|
# @param [Hash] opts the optional parameters
|
|
156
|
-
# @option opts [Integer] :page
|
|
157
|
-
# @option opts [Integer] :per_page
|
|
156
|
+
# @option opts [Integer] :page
|
|
157
|
+
# @option opts [Integer] :per_page
|
|
158
158
|
# @return [TradingConfigurationListBankModel]
|
|
159
159
|
def list_trading_configurations(opts = {})
|
|
160
160
|
data, _status_code, _headers = list_trading_configurations_with_http_info(opts)
|
|
@@ -164,8 +164,8 @@ module CybridApiBank
|
|
|
164
164
|
# List trading configurations
|
|
165
165
|
# Retrieves a listing of trading configurations for a bank. Required scope: **banks:read**
|
|
166
166
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @option opts [Integer] :page
|
|
168
|
-
# @option opts [Integer] :per_page
|
|
167
|
+
# @option opts [Integer] :page
|
|
168
|
+
# @option opts [Integer] :per_page
|
|
169
169
|
# @return [Array<(TradingConfigurationListBankModel, Integer, Hash)>] TradingConfigurationListBankModel data, response status code and response headers
|
|
170
170
|
def list_trading_configurations_with_http_info(opts = {})
|
|
171
171
|
if @api_client.config.debugging
|