cybrid_api_bank_ruby 0.109.61 → 0.110.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +14 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/BankBankModel.md +2 -0
  6. data/docs/DepositBankAccountAccountDetailsInnerBankModel.md +18 -0
  7. data/docs/DepositBankAccountBankModel.md +42 -0
  8. data/docs/DepositBankAccountCounterpartyAddressBankModel.md +28 -0
  9. data/docs/DepositBankAccountListBankModel.md +24 -0
  10. data/docs/DepositBankAccountRoutingDetailsInnerBankModel.md +20 -0
  11. data/docs/DepositBankAccountsBankApi.md +238 -0
  12. data/docs/PostBankBankModel.md +3 -1
  13. data/docs/PostDepositBankAccountBankModel.md +22 -0
  14. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +240 -0
  20. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +24 -2
  37. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +225 -0
  45. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +481 -0
  46. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +317 -0
  47. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +328 -0
  48. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +274 -0
  49. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +27 -5
  67. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +301 -0
  72. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  99. data/lib/cybrid_api_bank_ruby.rb +8 -1
  100. data/spec/api/accounts_bank_api_spec.rb +1 -1
  101. data/spec/api/assets_bank_api_spec.rb +1 -1
  102. data/spec/api/banks_bank_api_spec.rb +1 -1
  103. data/spec/api/customers_bank_api_spec.rb +1 -1
  104. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  105. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +76 -0
  106. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  107. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  108. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  109. data/spec/api/prices_bank_api_spec.rb +1 -1
  110. data/spec/api/quotes_bank_api_spec.rb +1 -1
  111. data/spec/api/symbols_bank_api_spec.rb +1 -1
  112. data/spec/api/trades_bank_api_spec.rb +1 -1
  113. data/spec/api/transfers_bank_api_spec.rb +1 -1
  114. data/spec/api/workflows_bank_api_spec.rb +1 -1
  115. data/spec/api_client_spec.rb +1 -1
  116. data/spec/configuration_spec.rb +1 -1
  117. data/spec/models/account_bank_model_spec.rb +1 -1
  118. data/spec/models/account_list_bank_model_spec.rb +1 -1
  119. data/spec/models/asset_bank_model_spec.rb +1 -1
  120. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  121. data/spec/models/bank_bank_model_spec.rb +11 -1
  122. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  123. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  124. data/spec/models/customer_bank_model_spec.rb +1 -1
  125. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  126. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  127. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  128. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  129. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +34 -0
  130. data/spec/models/deposit_bank_account_bank_model_spec.rb +110 -0
  131. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +64 -0
  132. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +52 -0
  133. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +44 -0
  134. data/spec/models/error_response_bank_model_spec.rb +1 -1
  135. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  136. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  137. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  138. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  139. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  140. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  141. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  142. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  143. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  144. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +1 -1
  145. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  146. data/spec/models/list_request_owner_bank_model_spec.rb +1 -1
  147. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  148. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  149. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  150. data/spec/models/post_account_bank_model_spec.rb +1 -1
  151. data/spec/models/post_bank_bank_model_spec.rb +11 -1
  152. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  153. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  154. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  155. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  156. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +46 -0
  157. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  158. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  159. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  160. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  161. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  162. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  163. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  164. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  165. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  166. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  167. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  168. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  169. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  170. data/spec/models/quote_bank_model_spec.rb +1 -1
  171. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  172. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  173. data/spec/models/trade_bank_model_spec.rb +1 -1
  174. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  175. data/spec/models/transfer_bank_model_spec.rb +1 -1
  176. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  177. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  178. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  179. data/spec/models/workflow_bank_model_spec.rb +1 -1
  180. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  181. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  182. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  183. data/spec/spec_helper.rb +1 -1
  184. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  185. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +5 -5
  186. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  187. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
  188. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
  189. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.9/gem_make.out +5 -5
  190. metadata +29 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 551558ece5b5691493546ae0da3c1f864695bf29814dec6c2829b0769d5241d1
4
- data.tar.gz: 49e5be7dbf820d17b991adf348604c29034afb61746177ce817b454ce152ae92
3
+ metadata.gz: 56edbecb16f701fc28970f2d87c0c31badda0cbf1f19c58580aa848bc9d8a9f2
4
+ data.tar.gz: eefd8273b11dbf917ac355932381b6759e819e5e4526cd357fbb6b761d97a6cd
5
5
  SHA512:
6
- metadata.gz: 70afbce34feefca205a9682be5d3c09dc727513415239f5235b2d612e93fa65e48843e4bff59d8c1036d80bf3ba53a1b775bda3daf343352d02c32fd66f35ccc
7
- data.tar.gz: f8d6127c82e1843e21d8418a74e0131257ddde9bf4db9672f3d526eb2af653ad39a640ccc73ec8cf490279d8de1ece3d14fe9668d7babb2bf32b6375a9497f4f
6
+ metadata.gz: 88954fc35145f44e5874efe9e58f62fdc7fba853b1a92ecabd289118b38289ce170042ee0cee2b65764386021095d25f4531d191bab22303a488e36aba018f64
7
+ data.tar.gz: ab6ec0d34cbc2c25f122701f48ce4ab4323ac2cee563f8ae11a4a8c1923e3abd2a19c87e4057967e8ed0b34b9b0a88f22311d72d8b4de0ff3fd12a548e33f059
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.109.61)
4
+ cybrid_api_bank_ruby (0.110.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -149,8 +149,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
149
149
 
150
150
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
151
151
 
152
- - API version: v0.109.61
153
- - Package version: 0.109.61
152
+ - API version: v0.110.0
153
+ - Package version: 0.110.0
154
154
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
155
155
 
156
156
  ## Installation
@@ -166,16 +166,16 @@ gem build cybrid_api_bank_ruby.gemspec
166
166
  Then either install the gem locally:
167
167
 
168
168
  ```shell
169
- gem install ./cybrid_api_bank_ruby-0.109.61.gem
169
+ gem install ./cybrid_api_bank_ruby-0.110.0.gem
170
170
  ```
171
171
 
172
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.109.61.gem` to install the development dependencies)
172
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.110.0.gem` to install the development dependencies)
173
173
 
174
174
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
175
175
 
176
176
  Finally add this to the Gemfile:
177
177
 
178
- gem 'cybrid_api_bank_ruby', '~> 0.109.61'
178
+ gem 'cybrid_api_bank_ruby', '~> 0.110.0'
179
179
 
180
180
  ### Install from Git
181
181
 
@@ -242,6 +242,9 @@ Class | Method | HTTP request | Description
242
242
  *CybridApiBank::DepositAddressesBankApi* | [**create_deposit_address**](docs/DepositAddressesBankApi.md#create_deposit_address) | **POST** /api/deposit_addresses | Create Deposit Address
243
243
  *CybridApiBank::DepositAddressesBankApi* | [**get_deposit_address**](docs/DepositAddressesBankApi.md#get_deposit_address) | **GET** /api/deposit_addresses/{deposit_address_guid} | Get Deposit Address
244
244
  *CybridApiBank::DepositAddressesBankApi* | [**list_deposit_addresses**](docs/DepositAddressesBankApi.md#list_deposit_addresses) | **GET** /api/deposit_addresses | List Deposit Addresses
245
+ *CybridApiBank::DepositBankAccountsBankApi* | [**create_deposit_bank_account**](docs/DepositBankAccountsBankApi.md#create_deposit_bank_account) | **POST** /api/deposit_bank_accounts | Create Deposit Bank Account
246
+ *CybridApiBank::DepositBankAccountsBankApi* | [**get_deposit_bank_account**](docs/DepositBankAccountsBankApi.md#get_deposit_bank_account) | **GET** /api/deposit_bank_accounts/{deposit_bank_account_guid} | Get Deposit Bank Account
247
+ *CybridApiBank::DepositBankAccountsBankApi* | [**list_deposit_bank_accounts**](docs/DepositBankAccountsBankApi.md#list_deposit_bank_accounts) | **GET** /api/deposit_bank_accounts | List Deposit Bank Accounts
245
248
  *CybridApiBank::ExternalBankAccountsBankApi* | [**create_external_bank_account**](docs/ExternalBankAccountsBankApi.md#create_external_bank_account) | **POST** /api/external_bank_accounts | Create ExternalBankAccount
246
249
  *CybridApiBank::ExternalBankAccountsBankApi* | [**delete_external_bank_account**](docs/ExternalBankAccountsBankApi.md#delete_external_bank_account) | **DELETE** /api/external_bank_accounts/{external_bank_account_guid} | Delete External Bank Account
247
250
  *CybridApiBank::ExternalBankAccountsBankApi* | [**get_external_bank_account**](docs/ExternalBankAccountsBankApi.md#get_external_bank_account) | **GET** /api/external_bank_accounts/{external_bank_account_guid} | Get External Bank Account
@@ -284,6 +287,11 @@ Class | Method | HTTP request | Description
284
287
  - [CybridApiBank::CustomerNameBankModel](docs/CustomerNameBankModel.md)
285
288
  - [CybridApiBank::DepositAddressBankModel](docs/DepositAddressBankModel.md)
286
289
  - [CybridApiBank::DepositAddressListBankModel](docs/DepositAddressListBankModel.md)
290
+ - [CybridApiBank::DepositBankAccountAccountDetailsInnerBankModel](docs/DepositBankAccountAccountDetailsInnerBankModel.md)
291
+ - [CybridApiBank::DepositBankAccountBankModel](docs/DepositBankAccountBankModel.md)
292
+ - [CybridApiBank::DepositBankAccountCounterpartyAddressBankModel](docs/DepositBankAccountCounterpartyAddressBankModel.md)
293
+ - [CybridApiBank::DepositBankAccountListBankModel](docs/DepositBankAccountListBankModel.md)
294
+ - [CybridApiBank::DepositBankAccountRoutingDetailsInnerBankModel](docs/DepositBankAccountRoutingDetailsInnerBankModel.md)
287
295
  - [CybridApiBank::ErrorResponseBankModel](docs/ErrorResponseBankModel.md)
288
296
  - [CybridApiBank::ExternalBankAccountBalancesBankModel](docs/ExternalBankAccountBalancesBankModel.md)
289
297
  - [CybridApiBank::ExternalBankAccountBankModel](docs/ExternalBankAccountBankModel.md)
@@ -306,6 +314,7 @@ Class | Method | HTTP request | Description
306
314
  - [CybridApiBank::PostCustomerBankModel](docs/PostCustomerBankModel.md)
307
315
  - [CybridApiBank::PostCustomerNameBankModel](docs/PostCustomerNameBankModel.md)
308
316
  - [CybridApiBank::PostDepositAddressBankModel](docs/PostDepositAddressBankModel.md)
317
+ - [CybridApiBank::PostDepositBankAccountBankModel](docs/PostDepositBankAccountBankModel.md)
309
318
  - [CybridApiBank::PostExternalBankAccountBankModel](docs/PostExternalBankAccountBankModel.md)
310
319
  - [CybridApiBank::PostExternalBankAccountCounterpartyAddressBankModel](docs/PostExternalBankAccountCounterpartyAddressBankModel.md)
311
320
  - [CybridApiBank::PostExternalBankAccountCounterpartyBankAccountBankModel](docs/PostExternalBankAccountCounterpartyBankAccountBankModel.md)
@@ -5,7 +5,7 @@
5
5
 
6
6
  ## 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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/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://kb.cybrid.xyz/locally-running-the-web-demo-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.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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 | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
7
7
 
8
- The version of the OpenAPI document: v0.109.61
8
+ The version of the OpenAPI document: v0.110.0
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -12,6 +12,7 @@
12
12
  | **supported_fiat_account_assets** | **Array&lt;String&gt;** | The bank&#39;s list of supported fiat symbols. | [optional] |
13
13
  | **supported_country_codes** | **Array&lt;String&gt;** | The bank&#39;s list of supported country codes. | [optional] |
14
14
  | **features** | **Array&lt;String&gt;** | The bank&#39;s enabled features. | |
15
+ | **routable_accounts** | **String** | Configuration for supporting creating routable bank accounts. | [optional] |
15
16
  | **created_at** | **Time** | ISO8601 datetime the bank was created at. | |
16
17
 
17
18
  ## Example
@@ -28,6 +29,7 @@ instance = CybridApiBank::BankBankModel.new(
28
29
  supported_fiat_account_assets: null,
29
30
  supported_country_codes: null,
30
31
  features: null,
32
+ routable_accounts: null,
31
33
  created_at: null
32
34
  )
33
35
  ```
@@ -0,0 +1,18 @@
1
+ # CybridApiBank::DepositBankAccountAccountDetailsInnerBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_number** | **String** | The account number. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'cybrid_api_bank_ruby'
13
+
14
+ instance = CybridApiBank::DepositBankAccountAccountDetailsInnerBankModel.new(
15
+ account_number: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,42 @@
1
+ # CybridApiBank::DepositBankAccountBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
8
+ | **bank_guid** | **String** | The address&#39; bank identifier. | [optional] |
9
+ | **customer_guid** | **String** | The address&#39; customer identifier. | [optional] |
10
+ | **account_guid** | **String** | The address&#39; account identifier. | [optional] |
11
+ | **created_at** | **Time** | ISO8601 datetime the address was created at. | [optional] |
12
+ | **asset** | **String** | The asset the transfer is related to, e.g., USD. | [optional] |
13
+ | **state** | **String** | The state of the address. | [optional] |
14
+ | **unique_memo_id** | **String** | The unique memo identifier for the address. This is used to identify the recipient when sending funds to the account. This value MUST be included in all wire transfers to this account. | [optional] |
15
+ | **counterparty_name** | **String** | The name of the account holder. | [optional] |
16
+ | **counterparty_address** | [**DepositBankAccountCounterpartyAddressBankModel**](DepositBankAccountCounterpartyAddressBankModel.md) | | [optional] |
17
+ | **account_details** | [**Array&lt;DepositBankAccountAccountDetailsInnerBankModel&gt;**](DepositBankAccountAccountDetailsInnerBankModel.md) | The account details for the bank account. | [optional] |
18
+ | **routing_details** | [**Array&lt;DepositBankAccountRoutingDetailsInnerBankModel&gt;**](DepositBankAccountRoutingDetailsInnerBankModel.md) | The account details for the bank account. | [optional] |
19
+ | **labels** | **Array&lt;String&gt;** | The labels associated with the address. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'cybrid_api_bank_ruby'
25
+
26
+ instance = CybridApiBank::DepositBankAccountBankModel.new(
27
+ guid: null,
28
+ bank_guid: null,
29
+ customer_guid: null,
30
+ account_guid: null,
31
+ created_at: null,
32
+ asset: null,
33
+ state: null,
34
+ unique_memo_id: null,
35
+ counterparty_name: null,
36
+ counterparty_address: null,
37
+ account_details: null,
38
+ routing_details: null,
39
+ labels: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,28 @@
1
+ # CybridApiBank::DepositBankAccountCounterpartyAddressBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street** | **String** | The first line of the address. | |
8
+ | **street2** | **String** | The optional second line of the address. | [optional] |
9
+ | **city** | **String** | The city of the address. | |
10
+ | **subdivision** | **String** | The provide/state/region of the address; not used by all countries. | [optional] |
11
+ | **postal_code** | **String** | The postal/post/zip code of the address; not used by all countries. | [optional] |
12
+ | **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'cybrid_api_bank_ruby'
18
+
19
+ instance = CybridApiBank::DepositBankAccountCounterpartyAddressBankModel.new(
20
+ street: null,
21
+ street2: null,
22
+ city: null,
23
+ subdivision: null,
24
+ postal_code: null,
25
+ country_code: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::DepositBankAccountListBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | The total number of records available. | |
8
+ | **page** | **Integer** | The page index to retrieve. | |
9
+ | **per_page** | **Integer** | The number of entities per page to return. | |
10
+ | **objects** | [**Array&lt;DepositBankAccountBankModel&gt;**](DepositBankAccountBankModel.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::DepositBankAccountListBankModel.new(
18
+ total: null,
19
+ page: null,
20
+ per_page: null,
21
+ objects: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # CybridApiBank::DepositBankAccountRoutingDetailsInnerBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **routing_number_type** | **String** | The type of routing number. | |
8
+ | **routing_number** | **String** | The routing number. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'cybrid_api_bank_ruby'
14
+
15
+ instance = CybridApiBank::DepositBankAccountRoutingDetailsInnerBankModel.new(
16
+ routing_number_type: null,
17
+ routing_number: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,238 @@
1
+ # CybridApiBank::DepositBankAccountsBankApi
2
+
3
+ All URIs are relative to *https://bank.sandbox.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_deposit_bank_account**](DepositBankAccountsBankApi.md#create_deposit_bank_account) | **POST** /api/deposit_bank_accounts | Create Deposit Bank Account |
8
+ | [**get_deposit_bank_account**](DepositBankAccountsBankApi.md#get_deposit_bank_account) | **GET** /api/deposit_bank_accounts/{deposit_bank_account_guid} | Get Deposit Bank Account |
9
+ | [**list_deposit_bank_accounts**](DepositBankAccountsBankApi.md#list_deposit_bank_accounts) | **GET** /api/deposit_bank_accounts | List Deposit Bank Accounts |
10
+
11
+
12
+ ## create_deposit_bank_account
13
+
14
+ > <DepositBankAccountBankModel> create_deposit_bank_account(post_deposit_bank_account_bank_model)
15
+
16
+ Create Deposit Bank Account
17
+
18
+ Creates a deposit bank account. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the deposit bank account details in our private store | | created | The Platform has created the deposit bank account | Required scope: **deposit_bank_accounts:execute**
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'cybrid_api_bank_ruby'
25
+ # setup authorization
26
+ CybridApiBank.configure do |config|
27
+ # Configure Bearer authorization (JWT): BearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+
30
+ # Configure OAuth2 access token for authorization: oauth2
31
+ config.access_token = 'YOUR ACCESS TOKEN'
32
+ end
33
+
34
+ api_instance = CybridApiBank::DepositBankAccountsBankApi.new
35
+ post_deposit_bank_account_bank_model = CybridApiBank::PostDepositBankAccountBankModel.new({account_guid: 'account_guid_example'}) # PostDepositBankAccountBankModel |
36
+
37
+ begin
38
+ # Create Deposit Bank Account
39
+ result = api_instance.create_deposit_bank_account(post_deposit_bank_account_bank_model)
40
+ p result
41
+ rescue CybridApiBank::ApiError => e
42
+ puts "Error when calling DepositBankAccountsBankApi->create_deposit_bank_account: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_deposit_bank_account_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<DepositBankAccountBankModel>, Integer, Hash)> create_deposit_bank_account_with_http_info(post_deposit_bank_account_bank_model)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create Deposit Bank Account
55
+ data, status_code, headers = api_instance.create_deposit_bank_account_with_http_info(post_deposit_bank_account_bank_model)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <DepositBankAccountBankModel>
59
+ rescue CybridApiBank::ApiError => e
60
+ puts "Error when calling DepositBankAccountsBankApi->create_deposit_bank_account_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **post_deposit_bank_account_bank_model** | [**PostDepositBankAccountBankModel**](PostDepositBankAccountBankModel.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**DepositBankAccountBankModel**](DepositBankAccountBankModel.md)
73
+
74
+ ### Authorization
75
+
76
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## get_deposit_bank_account
85
+
86
+ > <DepositBankAccountBankModel> get_deposit_bank_account(deposit_bank_account_guid)
87
+
88
+ Get Deposit Bank Account
89
+
90
+ Retrieves a deposit bank account. Required scope: **deposit_bank_accounts:read**
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'cybrid_api_bank_ruby'
97
+ # setup authorization
98
+ CybridApiBank.configure do |config|
99
+ # Configure Bearer authorization (JWT): BearerAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+
102
+ # Configure OAuth2 access token for authorization: oauth2
103
+ config.access_token = 'YOUR ACCESS TOKEN'
104
+ end
105
+
106
+ api_instance = CybridApiBank::DepositBankAccountsBankApi.new
107
+ deposit_bank_account_guid = 'deposit_bank_account_guid_example' # String | Identifier for the deposit bank account.
108
+
109
+ begin
110
+ # Get Deposit Bank Account
111
+ result = api_instance.get_deposit_bank_account(deposit_bank_account_guid)
112
+ p result
113
+ rescue CybridApiBank::ApiError => e
114
+ puts "Error when calling DepositBankAccountsBankApi->get_deposit_bank_account: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the get_deposit_bank_account_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(<DepositBankAccountBankModel>, Integer, Hash)> get_deposit_bank_account_with_http_info(deposit_bank_account_guid)
123
+
124
+ ```ruby
125
+ begin
126
+ # Get Deposit Bank Account
127
+ data, status_code, headers = api_instance.get_deposit_bank_account_with_http_info(deposit_bank_account_guid)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => <DepositBankAccountBankModel>
131
+ rescue CybridApiBank::ApiError => e
132
+ puts "Error when calling DepositBankAccountsBankApi->get_deposit_bank_account_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **deposit_bank_account_guid** | **String** | Identifier for the deposit bank account. | |
141
+
142
+ ### Return type
143
+
144
+ [**DepositBankAccountBankModel**](DepositBankAccountBankModel.md)
145
+
146
+ ### Authorization
147
+
148
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## list_deposit_bank_accounts
157
+
158
+ > <DepositBankAccountListBankModel> list_deposit_bank_accounts(opts)
159
+
160
+ List Deposit Bank Accounts
161
+
162
+ Retrieves a list of deposit bank accounts. Required scope: **deposit_bank_accounts:read**
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'cybrid_api_bank_ruby'
169
+ # setup authorization
170
+ CybridApiBank.configure do |config|
171
+ # Configure Bearer authorization (JWT): BearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
173
+
174
+ # Configure OAuth2 access token for authorization: oauth2
175
+ config.access_token = 'YOUR ACCESS TOKEN'
176
+ end
177
+
178
+ api_instance = CybridApiBank::DepositBankAccountsBankApi.new
179
+ opts = {
180
+ page: 56, # Integer | The page index to retrieve.
181
+ per_page: 56, # Integer | The number of entities per page to return.
182
+ guid: 'guid_example', # String | Comma separated guids to list deposit bank accounts for.
183
+ bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list deposit bank accounts for.
184
+ customer_guid: 'customer_guid_example', # String | Comma separated customer_guids to list deposit bank accounts for.
185
+ label: 'label_example' # String | Comma separated labels to list deposit bank accounts for.
186
+ }
187
+
188
+ begin
189
+ # List Deposit Bank Accounts
190
+ result = api_instance.list_deposit_bank_accounts(opts)
191
+ p result
192
+ rescue CybridApiBank::ApiError => e
193
+ puts "Error when calling DepositBankAccountsBankApi->list_deposit_bank_accounts: #{e}"
194
+ end
195
+ ```
196
+
197
+ #### Using the list_deposit_bank_accounts_with_http_info variant
198
+
199
+ This returns an Array which contains the response data, status code and headers.
200
+
201
+ > <Array(<DepositBankAccountListBankModel>, Integer, Hash)> list_deposit_bank_accounts_with_http_info(opts)
202
+
203
+ ```ruby
204
+ begin
205
+ # List Deposit Bank Accounts
206
+ data, status_code, headers = api_instance.list_deposit_bank_accounts_with_http_info(opts)
207
+ p status_code # => 2xx
208
+ p headers # => { ... }
209
+ p data # => <DepositBankAccountListBankModel>
210
+ rescue CybridApiBank::ApiError => e
211
+ puts "Error when calling DepositBankAccountsBankApi->list_deposit_bank_accounts_with_http_info: #{e}"
212
+ end
213
+ ```
214
+
215
+ ### Parameters
216
+
217
+ | Name | Type | Description | Notes |
218
+ | ---- | ---- | ----------- | ----- |
219
+ | **page** | **Integer** | The page index to retrieve. | [optional] |
220
+ | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
221
+ | **guid** | **String** | Comma separated guids to list deposit bank accounts for. | [optional] |
222
+ | **bank_guid** | **String** | Comma separated bank_guids to list deposit bank accounts for. | [optional] |
223
+ | **customer_guid** | **String** | Comma separated customer_guids to list deposit bank accounts for. | [optional] |
224
+ | **label** | **String** | Comma separated labels to list deposit bank accounts for. | [optional] |
225
+
226
+ ### Return type
227
+
228
+ [**DepositBankAccountListBankModel**](DepositBankAccountListBankModel.md)
229
+
230
+ ### Authorization
231
+
232
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: Not defined
237
+ - **Accept**: application/json
238
+
@@ -10,6 +10,7 @@
10
10
  | **features** | **Array&lt;String&gt;** | The bank&#39;s enabled features. | |
11
11
  | **supported_fiat_account_assets** | **Array&lt;String&gt;** | The bank&#39;s list of supported fiat assets. | |
12
12
  | **supported_country_codes** | **Array&lt;String&gt;** | The bank&#39;s list of supported country codes. | [optional] |
13
+ | **routable_accounts** | **String** | Configuration for supporting creating routable bank accounts. | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = CybridApiBank::PostBankBankModel.new(
22
23
  supported_trading_symbols: null,
23
24
  features: null,
24
25
  supported_fiat_account_assets: null,
25
- supported_country_codes: null
26
+ supported_country_codes: null,
27
+ routable_accounts: null
26
28
  )
27
29
  ```
28
30
 
@@ -0,0 +1,22 @@
1
+ # CybridApiBank::PostDepositBankAccountBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_guid** | **String** | The trading account guid. | |
8
+ | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
9
+ | **labels** | **Array&lt;String&gt;** | The labels associated with the address. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'cybrid_api_bank_ruby'
15
+
16
+ instance = CybridApiBank::PostDepositBankAccountBankModel.new(
17
+ account_guid: null,
18
+ customer_guid: null,
19
+ labels: null
20
+ )
21
+ ```
22
+
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/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://kb.cybrid.xyz/locally-running-the-web-demo-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.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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 | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.109.61
6
+ The version of the OpenAPI document: v0.110.0
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0