cybrid_api_bank_ruby 0.115.102 → 0.115.106

Sign up to get free protection for your applications and to get access to all the features.
Files changed (305) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +17 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/CounterpartiesBankApi.md +242 -0
  6. data/docs/CounterpartyAddressBankModel.md +28 -0
  7. data/docs/CounterpartyAliasesInnerBankModel.md +24 -0
  8. data/docs/CounterpartyBankModel.md +42 -0
  9. data/docs/CounterpartyListBankModel.md +24 -0
  10. data/docs/CounterpartyNameBankModel.md +24 -0
  11. data/docs/CounterpartyStateBankModel.md +15 -0
  12. data/docs/CounterpartyTypeBankModel.md +15 -0
  13. data/docs/PostCounterpartyBankModel.md +26 -0
  14. data/docs/PostCounterpartyNameBankModel.md +24 -0
  15. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +243 -0
  19. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +277 -0
  48. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +254 -0
  49. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +422 -0
  50. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +328 -0
  51. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +255 -0
  52. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +39 -0
  53. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +37 -0
  54. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  100. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +303 -0
  105. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +254 -0
  106. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  110. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  119. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  121. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  125. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  127. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  130. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
  131. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  132. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  133. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
  134. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  137. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  138. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  139. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  140. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  141. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
  142. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  143. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  144. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  145. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  146. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
  147. data/lib/cybrid_api_bank_ruby/models/verification_check_bank_model.rb +1 -1
  148. data/lib/cybrid_api_bank_ruby/models/verification_check_state_bank_model.rb +1 -1
  149. data/lib/cybrid_api_bank_ruby/models/verification_check_type_bank_model.rb +1 -1
  150. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  151. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  152. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  153. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  154. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  155. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  156. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  157. data/lib/cybrid_api_bank_ruby.rb +11 -1
  158. data/spec/api/accounts_bank_api_spec.rb +1 -1
  159. data/spec/api/assets_bank_api_spec.rb +1 -1
  160. data/spec/api/banks_bank_api_spec.rb +1 -1
  161. data/spec/api/counterparties_bank_api_spec.rb +77 -0
  162. data/spec/api/customers_bank_api_spec.rb +1 -1
  163. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  164. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  165. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  166. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  167. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  168. data/spec/api/invoices_bank_api_spec.rb +1 -1
  169. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  170. data/spec/api/prices_bank_api_spec.rb +1 -1
  171. data/spec/api/quotes_bank_api_spec.rb +1 -1
  172. data/spec/api/symbols_bank_api_spec.rb +1 -1
  173. data/spec/api/trades_bank_api_spec.rb +1 -1
  174. data/spec/api/transfers_bank_api_spec.rb +1 -1
  175. data/spec/api/workflows_bank_api_spec.rb +1 -1
  176. data/spec/api_client_spec.rb +1 -1
  177. data/spec/configuration_spec.rb +1 -1
  178. data/spec/models/account_bank_model_spec.rb +1 -1
  179. data/spec/models/account_list_bank_model_spec.rb +1 -1
  180. data/spec/models/account_state_bank_model_spec.rb +1 -1
  181. data/spec/models/account_type_bank_model_spec.rb +1 -1
  182. data/spec/models/asset_bank_model_spec.rb +1 -1
  183. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  184. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  185. data/spec/models/bank_bank_model_spec.rb +1 -1
  186. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  187. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  188. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  189. data/spec/models/counterparty_address_bank_model_spec.rb +64 -0
  190. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +52 -0
  191. data/spec/models/counterparty_bank_model_spec.rb +106 -0
  192. data/spec/models/counterparty_list_bank_model_spec.rb +52 -0
  193. data/spec/models/counterparty_name_bank_model_spec.rb +52 -0
  194. data/spec/models/counterparty_state_bank_model_spec.rb +28 -0
  195. data/spec/models/counterparty_type_bank_model_spec.rb +28 -0
  196. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  197. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  198. data/spec/models/customer_bank_model_spec.rb +1 -1
  199. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  200. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  201. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  202. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  203. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  204. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  205. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  206. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  207. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  208. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  209. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  210. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  211. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  212. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  213. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  214. data/spec/models/error_response_bank_model_spec.rb +1 -1
  215. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  216. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  217. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  218. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  219. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  220. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  221. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  222. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  223. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  224. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  225. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  226. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  227. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  228. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  229. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  230. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  231. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  232. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  233. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  234. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  235. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
  236. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  237. data/spec/models/invoice_bank_model_spec.rb +1 -1
  238. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  239. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  240. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  241. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  242. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  243. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  244. data/spec/models/post_account_bank_model_spec.rb +1 -1
  245. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  246. data/spec/models/post_counterparty_bank_model_spec.rb +62 -0
  247. data/spec/models/post_counterparty_name_bank_model_spec.rb +52 -0
  248. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  249. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  250. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  251. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  252. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  253. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  254. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  255. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  256. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  257. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  258. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  259. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  260. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  261. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  262. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  263. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  264. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  265. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  266. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  267. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  268. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  269. data/spec/models/quote_bank_model_spec.rb +1 -1
  270. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  271. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  272. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  273. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  274. data/spec/models/trade_bank_model_spec.rb +1 -1
  275. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  276. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  277. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  278. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  279. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  280. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  281. data/spec/models/transfer_bank_model_spec.rb +1 -1
  282. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  283. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  284. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  285. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  286. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  287. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  288. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  289. data/spec/models/verification_check_bank_model_spec.rb +1 -1
  290. data/spec/models/verification_check_state_bank_model_spec.rb +1 -1
  291. data/spec/models/verification_check_type_bank_model_spec.rb +1 -1
  292. data/spec/models/workflow_bank_model_spec.rb +1 -1
  293. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  294. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  295. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  296. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  297. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  298. data/spec/spec_helper.rb +1 -1
  299. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  300. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +5 -5
  301. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  302. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.2/gem_make.out +5 -5
  303. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
  304. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/gem_make.out +5 -5
  305. metadata +43 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a12685b2e2ea0c62a309e9ed7993776bc6aec317e1312c12ddc31774ac8aa1b7
4
- data.tar.gz: d68daa7dddd52939c8fc03d7e7213386925607e3f8e6a5bbb0e5aad6f87c24d9
3
+ metadata.gz: 644f7f5660e7fb18c84dcde30fd874a7e5bc3addf76e0176a891fc593ba05b8d
4
+ data.tar.gz: f41073d78d577abd69845a4fc6fe0886322f6cb30ce58dd69b4a9ffb4f5b15fe
5
5
  SHA512:
6
- metadata.gz: 3a756d6c63da0ea61ecb25fa7e7364889b4aafffe4ad1e508899886b33b0fb7317e5ec1f8fed15bc4fea99c721697389ba236a9129d617ed555c0eac57cbe5c6
7
- data.tar.gz: 17f5813b4431955a3e1a076a5651b5168ccb24c531357caaddcb98aa16ac3e7ff39ad6f2dc2119e17ca29c06e3886ea83af8609873c7a04b16047dd7632ec108
6
+ metadata.gz: 9df99d2efd6e40d73a51980e9a9ecde1cf081fabdc9ea682b9c8de0ee7b3ea6ed8d2154d7239c41c65e58e0381fc94cd78a99ccd5a072b8e3b9d6b427cd099ec
7
+ data.tar.gz: f8059d03312b78ff3bf8a9bc7cb61197772c6989cd9817a731b808dd85c94c4fb1075d2482c409bfa02be3a2a653e9c24ff9ca2fdf55a10fa19f192c08f8a7d0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.115.102)
4
+ cybrid_api_bank_ruby (0.115.106)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -152,8 +152,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
152
152
 
153
153
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
154
154
 
155
- - API version: v0.115.102
156
- - Package version: 0.115.102
155
+ - API version: v0.115.105
156
+ - Package version: 0.115.106
157
157
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
158
158
 
159
159
  ## Installation
@@ -169,16 +169,16 @@ gem build cybrid_api_bank_ruby.gemspec
169
169
  Then either install the gem locally:
170
170
 
171
171
  ```shell
172
- gem install ./cybrid_api_bank_ruby-0.115.102.gem
172
+ gem install ./cybrid_api_bank_ruby-0.115.106.gem
173
173
  ```
174
174
 
175
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.115.102.gem` to install the development dependencies)
175
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.115.106.gem` to install the development dependencies)
176
176
 
177
177
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
178
178
 
179
179
  Finally add this to the Gemfile:
180
180
 
181
- gem 'cybrid_api_bank_ruby', '~> 0.115.102'
181
+ gem 'cybrid_api_bank_ruby', '~> 0.115.106'
182
182
 
183
183
  ### Install from Git
184
184
 
@@ -238,6 +238,9 @@ Class | Method | HTTP request | Description
238
238
  *CybridApiBank::BanksBankApi* | [**get_bank**](docs/BanksBankApi.md#get_bank) | **GET** /api/banks/{bank_guid} | Get Bank
239
239
  *CybridApiBank::BanksBankApi* | [**list_banks**](docs/BanksBankApi.md#list_banks) | **GET** /api/banks | Get banks list
240
240
  *CybridApiBank::BanksBankApi* | [**update_bank**](docs/BanksBankApi.md#update_bank) | **PATCH** /api/banks/{bank_guid} | Patch Bank
241
+ *CybridApiBank::CounterpartiesBankApi* | [**create_counterparty**](docs/CounterpartiesBankApi.md#create_counterparty) | **POST** /api/counterparties | Create Counterparty
242
+ *CybridApiBank::CounterpartiesBankApi* | [**get_counterparty**](docs/CounterpartiesBankApi.md#get_counterparty) | **GET** /api/counterparties/{counterparty_guid} | Get Counterparty
243
+ *CybridApiBank::CounterpartiesBankApi* | [**list_counterparties**](docs/CounterpartiesBankApi.md#list_counterparties) | **GET** /api/counterparties | Get counterparties list
241
244
  *CybridApiBank::CustomersBankApi* | [**create_customer**](docs/CustomersBankApi.md#create_customer) | **POST** /api/customers | Create Customer
242
245
  *CybridApiBank::CustomersBankApi* | [**get_customer**](docs/CustomersBankApi.md#get_customer) | **GET** /api/customers/{customer_guid} | Get Customer
243
246
  *CybridApiBank::CustomersBankApi* | [**list_customers**](docs/CustomersBankApi.md#list_customers) | **GET** /api/customers | Get customers list
@@ -296,6 +299,13 @@ Class | Method | HTTP request | Description
296
299
  - [CybridApiBank::BankFeatureBankModel](docs/BankFeatureBankModel.md)
297
300
  - [CybridApiBank::BankListBankModel](docs/BankListBankModel.md)
298
301
  - [CybridApiBank::BankTypeBankModel](docs/BankTypeBankModel.md)
302
+ - [CybridApiBank::CounterpartyAddressBankModel](docs/CounterpartyAddressBankModel.md)
303
+ - [CybridApiBank::CounterpartyAliasesInnerBankModel](docs/CounterpartyAliasesInnerBankModel.md)
304
+ - [CybridApiBank::CounterpartyBankModel](docs/CounterpartyBankModel.md)
305
+ - [CybridApiBank::CounterpartyListBankModel](docs/CounterpartyListBankModel.md)
306
+ - [CybridApiBank::CounterpartyNameBankModel](docs/CounterpartyNameBankModel.md)
307
+ - [CybridApiBank::CounterpartyStateBankModel](docs/CounterpartyStateBankModel.md)
308
+ - [CybridApiBank::CounterpartyTypeBankModel](docs/CounterpartyTypeBankModel.md)
299
309
  - [CybridApiBank::CustomerAddressBankModel](docs/CustomerAddressBankModel.md)
300
310
  - [CybridApiBank::CustomerAliasesInnerBankModel](docs/CustomerAliasesInnerBankModel.md)
301
311
  - [CybridApiBank::CustomerBankModel](docs/CustomerBankModel.md)
@@ -346,6 +356,8 @@ Class | Method | HTTP request | Description
346
356
  - [CybridApiBank::PaymentInstructionListBankModel](docs/PaymentInstructionListBankModel.md)
347
357
  - [CybridApiBank::PostAccountBankModel](docs/PostAccountBankModel.md)
348
358
  - [CybridApiBank::PostBankBankModel](docs/PostBankBankModel.md)
359
+ - [CybridApiBank::PostCounterpartyBankModel](docs/PostCounterpartyBankModel.md)
360
+ - [CybridApiBank::PostCounterpartyNameBankModel](docs/PostCounterpartyNameBankModel.md)
349
361
  - [CybridApiBank::PostCustomerAddressBankModel](docs/PostCustomerAddressBankModel.md)
350
362
  - [CybridApiBank::PostCustomerBankModel](docs/PostCustomerBankModel.md)
351
363
  - [CybridApiBank::PostCustomerNameBankModel](docs/PostCustomerNameBankModel.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute' ``` <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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices: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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.115.102
8
+ The version of the OpenAPI document: v0.115.105
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -0,0 +1,242 @@
1
+ # CybridApiBank::CounterpartiesBankApi
2
+
3
+ All URIs are relative to *https://bank.sandbox.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_counterparty**](CounterpartiesBankApi.md#create_counterparty) | **POST** /api/counterparties | Create Counterparty |
8
+ | [**get_counterparty**](CounterpartiesBankApi.md#get_counterparty) | **GET** /api/counterparties/{counterparty_guid} | Get Counterparty |
9
+ | [**list_counterparties**](CounterpartiesBankApi.md#list_counterparties) | **GET** /api/counterparties | Get counterparties list |
10
+
11
+
12
+ ## create_counterparty
13
+
14
+ > <CounterpartyBankModel> create_counterparty(post_counterparty_bank_model)
15
+
16
+ Create Counterparty
17
+
18
+ Creates a counterparty. ## Counterparty Type Counterparty resources are an abstraction for real world individuals and businesses that are not directly on the Cybrid Platform. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the counterparty details in our private store | | unverified | The Platform has not yet verified the counterparty's identity | | verified | The Platform has verified the counterparty's identity | | rejected | The Platform was not able to successfully verify the counterparty's identity | Required scope: **counterparties: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::CounterpartiesBankApi.new
35
+ post_counterparty_bank_model = CybridApiBank::PostCounterpartyBankModel.new({type: 'business'}) # PostCounterpartyBankModel |
36
+
37
+ begin
38
+ # Create Counterparty
39
+ result = api_instance.create_counterparty(post_counterparty_bank_model)
40
+ p result
41
+ rescue CybridApiBank::ApiError => e
42
+ puts "Error when calling CounterpartiesBankApi->create_counterparty: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_counterparty_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<CounterpartyBankModel>, Integer, Hash)> create_counterparty_with_http_info(post_counterparty_bank_model)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create Counterparty
55
+ data, status_code, headers = api_instance.create_counterparty_with_http_info(post_counterparty_bank_model)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <CounterpartyBankModel>
59
+ rescue CybridApiBank::ApiError => e
60
+ puts "Error when calling CounterpartiesBankApi->create_counterparty_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **post_counterparty_bank_model** | [**PostCounterpartyBankModel**](PostCounterpartyBankModel.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**CounterpartyBankModel**](CounterpartyBankModel.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_counterparty
85
+
86
+ > <CounterpartyBankModel> get_counterparty(counterparty_guid, opts)
87
+
88
+ Get Counterparty
89
+
90
+ Retrieves a counterparty. Required scope: **counterparties: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::CounterpartiesBankApi.new
107
+ counterparty_guid = 'counterparty_guid_example' # String | Identifier for the counterparty.
108
+ opts = {
109
+ include_pii: true # Boolean | Include PII in the response.
110
+ }
111
+
112
+ begin
113
+ # Get Counterparty
114
+ result = api_instance.get_counterparty(counterparty_guid, opts)
115
+ p result
116
+ rescue CybridApiBank::ApiError => e
117
+ puts "Error when calling CounterpartiesBankApi->get_counterparty: #{e}"
118
+ end
119
+ ```
120
+
121
+ #### Using the get_counterparty_with_http_info variant
122
+
123
+ This returns an Array which contains the response data, status code and headers.
124
+
125
+ > <Array(<CounterpartyBankModel>, Integer, Hash)> get_counterparty_with_http_info(counterparty_guid, opts)
126
+
127
+ ```ruby
128
+ begin
129
+ # Get Counterparty
130
+ data, status_code, headers = api_instance.get_counterparty_with_http_info(counterparty_guid, opts)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => <CounterpartyBankModel>
134
+ rescue CybridApiBank::ApiError => e
135
+ puts "Error when calling CounterpartiesBankApi->get_counterparty_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **counterparty_guid** | **String** | Identifier for the counterparty. | |
144
+ | **include_pii** | **Boolean** | Include PII in the response. | [optional] |
145
+
146
+ ### Return type
147
+
148
+ [**CounterpartyBankModel**](CounterpartyBankModel.md)
149
+
150
+ ### Authorization
151
+
152
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
153
+
154
+ ### HTTP request headers
155
+
156
+ - **Content-Type**: Not defined
157
+ - **Accept**: application/json
158
+
159
+
160
+ ## list_counterparties
161
+
162
+ > <CounterpartyListBankModel> list_counterparties(opts)
163
+
164
+ Get counterparties list
165
+
166
+ Retrieves a listing of counterparties. Required scope: **counterparties:read**
167
+
168
+ ### Examples
169
+
170
+ ```ruby
171
+ require 'time'
172
+ require 'cybrid_api_bank_ruby'
173
+ # setup authorization
174
+ CybridApiBank.configure do |config|
175
+ # Configure Bearer authorization (JWT): BearerAuth
176
+ config.access_token = 'YOUR_BEARER_TOKEN'
177
+
178
+ # Configure OAuth2 access token for authorization: oauth2
179
+ config.access_token = 'YOUR ACCESS TOKEN'
180
+ end
181
+
182
+ api_instance = CybridApiBank::CounterpartiesBankApi.new
183
+ opts = {
184
+ page: 56, # Integer |
185
+ per_page: 56, # Integer |
186
+ bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list counterparties for.
187
+ customer_guid: 'customer_guid_example', # String | Comma separated customer_guids to list counterparties for.
188
+ guid: 'guid_example', # String | Comma separated counterparty_guids to list counterparties for.
189
+ label: 'label_example' # String | Comma separated labels to list counterparties for.
190
+ }
191
+
192
+ begin
193
+ # Get counterparties list
194
+ result = api_instance.list_counterparties(opts)
195
+ p result
196
+ rescue CybridApiBank::ApiError => e
197
+ puts "Error when calling CounterpartiesBankApi->list_counterparties: #{e}"
198
+ end
199
+ ```
200
+
201
+ #### Using the list_counterparties_with_http_info variant
202
+
203
+ This returns an Array which contains the response data, status code and headers.
204
+
205
+ > <Array(<CounterpartyListBankModel>, Integer, Hash)> list_counterparties_with_http_info(opts)
206
+
207
+ ```ruby
208
+ begin
209
+ # Get counterparties list
210
+ data, status_code, headers = api_instance.list_counterparties_with_http_info(opts)
211
+ p status_code # => 2xx
212
+ p headers # => { ... }
213
+ p data # => <CounterpartyListBankModel>
214
+ rescue CybridApiBank::ApiError => e
215
+ puts "Error when calling CounterpartiesBankApi->list_counterparties_with_http_info: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ | Name | Type | Description | Notes |
222
+ | ---- | ---- | ----------- | ----- |
223
+ | **page** | **Integer** | | [optional] |
224
+ | **per_page** | **Integer** | | [optional] |
225
+ | **bank_guid** | **String** | Comma separated bank_guids to list counterparties for. | [optional] |
226
+ | **customer_guid** | **String** | Comma separated customer_guids to list counterparties for. | [optional] |
227
+ | **guid** | **String** | Comma separated counterparty_guids to list counterparties for. | [optional] |
228
+ | **label** | **String** | Comma separated labels to list counterparties for. | [optional] |
229
+
230
+ ### Return type
231
+
232
+ [**CounterpartyListBankModel**](CounterpartyListBankModel.md)
233
+
234
+ ### Authorization
235
+
236
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
237
+
238
+ ### HTTP request headers
239
+
240
+ - **Content-Type**: Not defined
241
+ - **Accept**: application/json
242
+
@@ -0,0 +1,28 @@
1
+ # CybridApiBank::CounterpartyAddressBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street** | **String** | The first line of the address. | [optional] |
8
+ | **street2** | **String** | The optional second line of the address. | [optional] |
9
+ | **city** | **String** | The city of the address. | [optional] |
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. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'cybrid_api_bank_ruby'
18
+
19
+ instance = CybridApiBank::CounterpartyAddressBankModel.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::CounterpartyAliasesInnerBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first** | **String** | The counterparty&#39;s first name. | [optional] |
8
+ | **middle** | **String** | The counterparty&#39;s middle name. | [optional] |
9
+ | **last** | **String** | The counterparty&#39;s last name. | [optional] |
10
+ | **full** | **String** | The counterparty&#39;s full name. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::CounterpartyAliasesInnerBankModel.new(
18
+ first: null,
19
+ middle: null,
20
+ last: null,
21
+ full: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,42 @@
1
+ # CybridApiBank::CounterpartyBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Auto-generated unique identifier for the counterparty. | [optional] |
8
+ | **type** | **String** | The counterparty type; one of business or individual. | [optional] |
9
+ | **bank_guid** | **String** | Auto-generated unique identifier for the counterparty&#39;s bank. | [optional] |
10
+ | **customer_guid** | **String** | Auto-generated unique identifier for the counterparty&#39;s customer. | [optional] |
11
+ | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
12
+ | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
13
+ | **state** | **String** | The counterparty state; one of storing, unverified, verified, or rejected. | [optional] |
14
+ | **name** | [**CounterpartyNameBankModel**](CounterpartyNameBankModel.md) | | [optional] |
15
+ | **address** | [**CounterpartyAddressBankModel**](CounterpartyAddressBankModel.md) | | [optional] |
16
+ | **aliases** | [**Array&lt;CounterpartyAliasesInnerBankModel&gt;**](CounterpartyAliasesInnerBankModel.md) | The counterparty&#39;s aliases. Only available for GET operations when &#39;include_pii&#39; is set. | [optional] |
17
+ | **date_of_birth** | **Date** | The counterparty&#39;s DOB. Only available for GET operations when &#39;include_pii&#39; is set. | [optional] |
18
+ | **labels** | **Array&lt;String&gt;** | The labels associated with the customer. | [optional] |
19
+ | **verification_checks** | [**Array&lt;VerificationCheckBankModel&gt;**](VerificationCheckBankModel.md) | The verification checks associated with the customer. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'cybrid_api_bank_ruby'
25
+
26
+ instance = CybridApiBank::CounterpartyBankModel.new(
27
+ guid: null,
28
+ type: null,
29
+ bank_guid: null,
30
+ customer_guid: null,
31
+ created_at: null,
32
+ updated_at: null,
33
+ state: null,
34
+ name: null,
35
+ address: null,
36
+ aliases: null,
37
+ date_of_birth: null,
38
+ labels: null,
39
+ verification_checks: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::CounterpartyListBankModel
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;CounterpartyBankModel&gt;**](CounterpartyBankModel.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::CounterpartyListBankModel.new(
18
+ total: null,
19
+ page: null,
20
+ per_page: null,
21
+ objects: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::CounterpartyNameBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first** | **String** | The counterparty&#39;s first name. | [optional] |
8
+ | **middle** | **String** | The counterparty&#39;s middle name. | [optional] |
9
+ | **last** | **String** | The counterparty&#39;s last name. | [optional] |
10
+ | **full** | **String** | The counterparty&#39;s full name. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::CounterpartyNameBankModel.new(
18
+ first: null,
19
+ middle: null,
20
+ last: null,
21
+ full: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # CybridApiBank::CounterpartyStateBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'cybrid_api_bank_ruby'
12
+
13
+ instance = CybridApiBank::CounterpartyStateBankModel.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # CybridApiBank::CounterpartyTypeBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'cybrid_api_bank_ruby'
12
+
13
+ instance = CybridApiBank::CounterpartyTypeBankModel.new()
14
+ ```
15
+
@@ -0,0 +1,26 @@
1
+ # CybridApiBank::PostCounterpartyBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The counterparty&#39;s type. | |
8
+ | **name** | [**PostCounterpartyNameBankModel**](PostCounterpartyNameBankModel.md) | | [optional] |
9
+ | **address** | [**PostCustomerAddressBankModel**](PostCustomerAddressBankModel.md) | | [optional] |
10
+ | **date_of_birth** | **Date** | The counterparty&#39;s date of birth. | [optional] |
11
+ | **labels** | **Array&lt;String&gt;** | The labels associated with the counterparty. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'cybrid_api_bank_ruby'
17
+
18
+ instance = CybridApiBank::PostCounterpartyBankModel.new(
19
+ type: null,
20
+ name: null,
21
+ address: null,
22
+ date_of_birth: null,
23
+ labels: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::PostCounterpartyNameBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first** | **String** | The counterparty&#39;s first name. | [optional] |
8
+ | **middle** | **String** | The counterparty&#39;s middle name. | [optional] |
9
+ | **last** | **String** | The counterparty&#39;s last name. | [optional] |
10
+ | **full** | **String** | The counterparty&#39;s full name. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::PostCounterpartyNameBankModel.new(
18
+ first: null,
19
+ middle: null,
20
+ last: null,
21
+ full: null
22
+ )
23
+ ```
24
+
@@ -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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute' ``` <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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices: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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.115.102
6
+ The version of the OpenAPI document: v0.115.105
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0