cybrid_api_bank_ruby 0.129.899 → 0.129.1022

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (538) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +6 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/ActivityLimitBankModel.md +1 -1
  6. data/docs/ComplianceCheckBankModel.md +1 -1
  7. data/docs/ComplianceDecisionBankModel.md +1 -1
  8. data/docs/ExecutionBankModel.md +2 -2
  9. data/docs/IdentityVerificationBankModel.md +1 -1
  10. data/docs/IdentityVerificationWithDetailsBankModel.md +1 -1
  11. data/docs/IdentityVerificationWithDetailsPiiBankModel.md +4 -0
  12. data/docs/PayoutReturnDetailsBankModel.md +18 -0
  13. data/docs/PlanBankModel.md +2 -2
  14. data/docs/PostIdentityVerificationAddressBankModel.md +6 -6
  15. data/docs/PostIdentityVerificationBankModel.md +10 -6
  16. data/docs/PostIdentityVerificationNameBankModel.md +4 -4
  17. data/docs/PostPlanBankModel.md +1 -1
  18. data/docs/QuoteBankModel.md +1 -1
  19. data/docs/StageBankModel.md +4 -2
  20. data/docs/TradeBankModel.md +1 -1
  21. data/docs/TradesBankApi.md +1 -1
  22. data/docs/TransferBankModel.md +2 -2
  23. data/docs/TransfersBankApi.md +1 -1
  24. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +3 -3
  45. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +3 -3
  46. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +2 -1
  63. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +2 -1
  69. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +2 -1
  72. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/effective_rate_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +3 -3
  100. data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  105. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  106. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  110. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  119. data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +1 -1
  121. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +2 -1
  125. data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  127. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  130. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  131. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
  132. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +1 -1
  133. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +58 -2
  134. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  137. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  138. data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +1 -1
  139. data/lib/cybrid_api_bank_ruby/models/patch_account_bank_model.rb +1 -1
  140. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  141. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  142. data/lib/cybrid_api_bank_ruby/models/patch_deposit_address_bank_model.rb +1 -1
  143. data/lib/cybrid_api_bank_ruby/models/patch_deposit_bank_account_bank_model.rb +1 -1
  144. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  145. data/lib/cybrid_api_bank_ruby/models/patch_external_wallet_bank_model.rb +1 -1
  146. data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +1 -1
  147. data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +1 -1
  148. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  149. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  150. data/lib/cybrid_api_bank_ruby/models/payout_return_details_bank_model.rb +225 -0
  151. data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +1 -1
  152. data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +1 -1
  153. data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +3 -3
  154. data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +1 -1
  155. data/lib/cybrid_api_bank_ruby/models/plan_reference_bank_model.rb +1 -1
  156. data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +1 -1
  157. data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +1 -1
  158. data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +1 -1
  159. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  160. data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +1 -1
  161. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  162. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +1 -1
  163. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +1 -1
  164. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +1 -1
  165. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +1 -1
  166. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  167. data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +1 -1
  168. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  169. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  170. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  171. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  172. data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +1 -1
  173. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  174. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  175. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  176. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  177. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  178. data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +1 -1
  179. data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +1 -1
  180. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  181. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +8 -8
  182. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +1 -1
  183. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +56 -10
  184. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +6 -6
  185. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +1 -1
  186. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
  187. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
  188. data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +1 -1
  189. data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +4 -4
  190. data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +1 -1
  191. data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +1 -1
  192. data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +1 -1
  193. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +3 -3
  194. data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +1 -1
  195. data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +1 -1
  196. data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +1 -1
  197. data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +1 -1
  198. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  199. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +3 -3
  200. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +1 -1
  201. data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +1 -1
  202. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  203. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  204. data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +1 -1
  205. data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +1 -1
  206. data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +1 -1
  207. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  208. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  209. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +9 -3
  210. data/lib/cybrid_api_bank_ruby/models/return_details_bank_model.rb +1 -1
  211. data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +1 -1
  212. data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +15 -6
  213. data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +1 -1
  214. data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +1 -1
  215. data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +1 -1
  216. data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +1 -1
  217. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  218. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  219. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +2 -1
  220. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  221. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  222. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  223. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  224. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  225. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +3 -3
  226. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  227. data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +1 -1
  228. data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +1 -1
  229. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +2 -1
  230. data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +1 -1
  231. data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +1 -1
  232. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  233. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
  234. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  235. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  236. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  237. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +3 -1
  238. data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +1 -1
  239. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  240. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  241. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  242. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  243. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  244. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  245. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  246. data/lib/cybrid_api_bank_ruby.rb +2 -1
  247. data/spec/api/accounts_bank_api_spec.rb +1 -1
  248. data/spec/api/assets_bank_api_spec.rb +1 -1
  249. data/spec/api/banks_bank_api_spec.rb +1 -1
  250. data/spec/api/counterparties_bank_api_spec.rb +1 -1
  251. data/spec/api/customers_bank_api_spec.rb +1 -1
  252. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  253. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  254. data/spec/api/executions_bank_api_spec.rb +1 -1
  255. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  256. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  257. data/spec/api/files_bank_api_spec.rb +1 -1
  258. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  259. data/spec/api/invoices_bank_api_spec.rb +1 -1
  260. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  261. data/spec/api/persona_sessions_bank_api_spec.rb +1 -1
  262. data/spec/api/plans_bank_api_spec.rb +1 -1
  263. data/spec/api/prices_bank_api_spec.rb +1 -1
  264. data/spec/api/quotes_bank_api_spec.rb +1 -1
  265. data/spec/api/sardine_sessions_bank_api_spec.rb +1 -1
  266. data/spec/api/symbols_bank_api_spec.rb +1 -1
  267. data/spec/api/trades_bank_api_spec.rb +2 -2
  268. data/spec/api/transfers_bank_api_spec.rb +2 -2
  269. data/spec/api/workflows_bank_api_spec.rb +1 -1
  270. data/spec/api_client_spec.rb +1 -1
  271. data/spec/configuration_spec.rb +1 -1
  272. data/spec/models/account_association_bank_model_spec.rb +1 -1
  273. data/spec/models/account_bank_model_spec.rb +1 -1
  274. data/spec/models/account_list_bank_model_spec.rb +1 -1
  275. data/spec/models/account_state_bank_model_spec.rb +1 -1
  276. data/spec/models/account_type_bank_model_spec.rb +1 -1
  277. data/spec/models/activity_limit_bank_model_spec.rb +1 -1
  278. data/spec/models/activity_side_bank_model_spec.rb +1 -1
  279. data/spec/models/activity_type_bank_model_spec.rb +1 -1
  280. data/spec/models/asset_bank_model_spec.rb +1 -1
  281. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  282. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  283. data/spec/models/bank_bank_model_spec.rb +1 -1
  284. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  285. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  286. data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +1 -1
  287. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  288. data/spec/models/compliance_check_bank_model_spec.rb +1 -1
  289. data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
  290. data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
  291. data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
  292. data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
  293. data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
  294. data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
  295. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
  296. data/spec/models/counterparty_bank_model_spec.rb +1 -1
  297. data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
  298. data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
  299. data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
  300. data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
  301. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  302. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  303. data/spec/models/customer_bank_model_spec.rb +1 -1
  304. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  305. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  306. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  307. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  308. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  309. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  310. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  311. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  312. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  313. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  314. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  315. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  316. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  317. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  318. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  319. data/spec/models/effective_rate_bank_model_spec.rb +1 -1
  320. data/spec/models/error_response_bank_model_spec.rb +1 -1
  321. data/spec/models/execution_bank_model_spec.rb +1 -1
  322. data/spec/models/execution_list_bank_model_spec.rb +1 -1
  323. data/spec/models/execution_travel_rule_info_bank_model_spec.rb +1 -1
  324. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  325. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  326. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  327. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  328. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  329. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  330. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +1 -1
  331. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  332. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  333. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  334. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  335. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  336. data/spec/models/fee_association_bank_model_spec.rb +1 -1
  337. data/spec/models/fee_detail_bank_model_spec.rb +1 -1
  338. data/spec/models/hold_detail_bank_model_spec.rb +1 -1
  339. data/spec/models/identification_number_bank_model_spec.rb +1 -1
  340. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  341. data/spec/models/identity_verification_business_associate_bank_model_spec.rb +1 -1
  342. data/spec/models/identity_verification_document_bank_model_spec.rb +1 -1
  343. data/spec/models/identity_verification_document_file_bank_model_spec.rb +1 -1
  344. data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +1 -1
  345. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  346. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  347. data/spec/models/identity_verification_options_bank_model_spec.rb +1 -1
  348. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  349. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  350. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  351. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  352. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  353. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  354. data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +1 -1
  355. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +17 -1
  356. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  357. data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +1 -1
  358. data/spec/models/invoice_bank_model_spec.rb +1 -1
  359. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  360. data/spec/models/legal_entity_name_bank_model_spec.rb +1 -1
  361. data/spec/models/patch_account_bank_model_spec.rb +1 -1
  362. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  363. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  364. data/spec/models/patch_deposit_address_bank_model_spec.rb +1 -1
  365. data/spec/models/patch_deposit_bank_account_bank_model_spec.rb +1 -1
  366. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  367. data/spec/models/patch_external_wallet_bank_model_spec.rb +1 -1
  368. data/spec/models/patch_transfer_bank_model_spec.rb +1 -1
  369. data/spec/models/patch_transfer_participant_bank_model_spec.rb +1 -1
  370. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  371. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  372. data/spec/models/payout_return_details_bank_model_spec.rb +34 -0
  373. data/spec/models/persona_session_bank_model_spec.rb +1 -1
  374. data/spec/models/physical_address_bank_model_spec.rb +1 -1
  375. data/spec/models/plan_bank_model_spec.rb +1 -1
  376. data/spec/models/plan_list_bank_model_spec.rb +1 -1
  377. data/spec/models/plan_reference_bank_model_spec.rb +1 -1
  378. data/spec/models/plan_travel_rule_info_bank_model_spec.rb +1 -1
  379. data/spec/models/platform_file_bank_model_spec.rb +1 -1
  380. data/spec/models/platform_file_list_bank_model_spec.rb +1 -1
  381. data/spec/models/post_account_bank_model_spec.rb +1 -1
  382. data/spec/models/post_bank_account_details_bank_model_spec.rb +1 -1
  383. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  384. data/spec/models/post_counterparty_address_bank_model_spec.rb +1 -1
  385. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +1 -1
  386. data/spec/models/post_counterparty_bank_model_spec.rb +1 -1
  387. data/spec/models/post_counterparty_name_bank_model_spec.rb +1 -1
  388. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  389. data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +1 -1
  390. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  391. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  392. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  393. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  394. data/spec/models/post_execution_bank_model_spec.rb +1 -1
  395. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  396. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  397. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  398. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  399. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  400. data/spec/models/post_file_bank_model_spec.rb +1 -1
  401. data/spec/models/post_file_metadata_bank_model_spec.rb +1 -1
  402. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  403. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  404. data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +1 -1
  405. data/spec/models/post_identity_verification_bank_model_spec.rb +22 -2
  406. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  407. data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +1 -1
  408. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  409. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  410. data/spec/models/post_persona_session_bank_model_spec.rb +1 -1
  411. data/spec/models/post_plan_bank_model_spec.rb +2 -2
  412. data/spec/models/post_plan_destination_account_bank_model_spec.rb +1 -1
  413. data/spec/models/post_plan_source_account_bank_model_spec.rb +1 -1
  414. data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +1 -1
  415. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  416. data/spec/models/post_quote_entry_bank_model_spec.rb +1 -1
  417. data/spec/models/post_sardine_session_bank_model_spec.rb +1 -1
  418. data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +1 -1
  419. data/spec/models/post_supporting_document_bank_model_spec.rb +1 -1
  420. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  421. data/spec/models/post_transfer_bank_model_spec.rb +2 -2
  422. data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
  423. data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +1 -1
  424. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  425. data/spec/models/quote_bank_model_spec.rb +1 -1
  426. data/spec/models/quote_entry_bank_model_spec.rb +1 -1
  427. data/spec/models/quote_entry_destination_account_bank_model_spec.rb +1 -1
  428. data/spec/models/quote_entry_source_account_bank_model_spec.rb +1 -1
  429. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  430. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  431. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  432. data/spec/models/return_details_bank_model_spec.rb +1 -1
  433. data/spec/models/sardine_session_bank_model_spec.rb +1 -1
  434. data/spec/models/stage_bank_model_spec.rb +7 -1
  435. data/spec/models/stage_identifier_bank_model_spec.rb +1 -1
  436. data/spec/models/stage_link_bank_model_spec.rb +1 -1
  437. data/spec/models/supporting_document_bank_model_spec.rb +1 -1
  438. data/spec/models/supporting_document_file_bank_model_spec.rb +1 -1
  439. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  440. data/spec/models/trade_bank_model_spec.rb +1 -1
  441. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  442. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  443. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  444. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  445. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  446. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  447. data/spec/models/transfer_bank_model_spec.rb +1 -1
  448. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  449. data/spec/models/transfer_entry_bank_model_spec.rb +1 -1
  450. data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +1 -1
  451. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  452. data/spec/models/transfer_hold_details_bank_model_spec.rb +1 -1
  453. data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +1 -1
  454. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  455. data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
  456. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  457. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  458. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  459. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  460. data/spec/models/travel_rule_info_party_bank_model_spec.rb +1 -1
  461. data/spec/models/workflow_bank_model_spec.rb +1 -1
  462. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  463. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  464. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  465. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  466. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  467. data/spec/spec_helper.rb +1 -1
  468. data/vendor/bundle/ruby/4.0.0/cache/psych-5.5.0.gem +0 -0
  469. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
  470. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
  471. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.9.2/gem_make.out +5 -5
  472. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  473. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/gem_make.out +18 -18
  474. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.5.0/psych.so +0 -0
  475. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
  476. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
  477. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/README.md +53 -0
  478. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/extconf.rb +22 -0
  479. data/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych/psych.c +68 -0
  480. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych.h +4 -0
  481. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_emitter.c +4 -0
  482. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_parser.c +79 -18
  483. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/class_loader.rb +1 -0
  484. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/parser.rb +40 -1
  485. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/scalar_scanner.rb +15 -3
  486. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/versions.rb +1 -1
  487. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/to_ruby.rb +20 -9
  488. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/yaml_tree.rb +0 -3
  489. data/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/lib/psych.so +0 -0
  490. data/vendor/bundle/ruby/4.0.0/specifications/{psych-5.4.0.gemspec → psych-5.5.0.gemspec} +2 -2
  491. metadata +65 -61
  492. data/vendor/bundle/ruby/4.0.0/cache/psych-5.4.0.gem +0 -0
  493. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.4.0/psych.so +0 -0
  494. data/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych/psych.c +0 -36
  495. data/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/lib/psych.so +0 -0
  496. /data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/gem.build_complete +0 -0
  497. /data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/mkmf.log +0 -0
  498. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/CONTRIBUTING.md +0 -0
  499. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/LICENSE +0 -0
  500. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/Makefile +0 -0
  501. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/depend +0 -0
  502. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_emitter.h +0 -0
  503. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_parser.h +0 -0
  504. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_to_ruby.c +0 -0
  505. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_to_ruby.h +0 -0
  506. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_yaml_tree.c +0 -0
  507. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_yaml_tree.h +0 -0
  508. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/coder.rb +0 -0
  509. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/core_ext.rb +0 -0
  510. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/exception.rb +0 -0
  511. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handler.rb +0 -0
  512. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handlers/document_stream.rb +0 -0
  513. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handlers/recorder.rb +0 -0
  514. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/ruby_events.rb +0 -0
  515. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/stream.rb +0 -0
  516. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/tree_builder.rb +0 -0
  517. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/yaml_events.rb +0 -0
  518. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/alias.rb +0 -0
  519. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/document.rb +0 -0
  520. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/mapping.rb +0 -0
  521. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/node.rb +0 -0
  522. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/scalar.rb +0 -0
  523. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/sequence.rb +0 -0
  524. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/stream.rb +0 -0
  525. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes.rb +0 -0
  526. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/omap.rb +0 -0
  527. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/set.rb +0 -0
  528. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/stream.rb +0 -0
  529. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/streaming.rb +0 -0
  530. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/syntax_error.rb +0 -0
  531. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/tree_builder.rb +0 -0
  532. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/depth_first.rb +0 -0
  533. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/emitter.rb +0 -0
  534. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/json_tree.rb +0 -0
  535. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/visitor.rb +0 -0
  536. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors.rb +0 -0
  537. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/y.rb +0 -0
  538. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych.rb +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 48d476d8d6632b2c896d8f85303208771db263b7d39fc7671e976b5e1b08fbd7
4
- data.tar.gz: 51a215df07f2270bb74a0ec6f5c074a08a692de6006204c25ad8cff4f25ffdf4
3
+ metadata.gz: 60452a99662f3a74af71c35ec957d6ae136d189ae5c7bdabe21862ae91ce1689
4
+ data.tar.gz: 270e9f8f41a572df8b0e640241a116a413629d106dc18d6d5900182608e8f283
5
5
  SHA512:
6
- metadata.gz: 00164f14761c5d4f2e38f4e5aea95b7d18105f2391fd630354ef99890d03cae0cdac49909f4376cd6ae461f39777f310027ada49bf3ac834c5d1c4a03035b487
7
- data.tar.gz: bf6fe257f49f74257b3d779d2eb6c831b5c3573ead72ace91e9e7fffe3a51db89ac437954e178d8bb50d0663ccd879c8e5dfdbead8049151001fc5e7beeee56d
6
+ metadata.gz: ee357697e9ade4ef0d01a053b78693d637ea3895747cce2d366d4d6740b82b5d09dc2578f8e69203391cbe96686060ba5270e3e5d19e878bf655daa019e684b9
7
+ data.tar.gz: 92ed3e8b571e31b22c24c5f48f84f2cf2ac45d82a5c967db7359abf40e469dba7b933940cc46eee9ec4b9bd84a0ad68e20e5cd779e8bdced9d6b662e878bb22a
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.129.899)
4
+ cybrid_api_bank_ruby (0.129.1022)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -42,7 +42,7 @@ GEM
42
42
  pry-byebug (3.12.0)
43
43
  byebug (~> 13.0)
44
44
  pry (>= 0.13, < 0.17)
45
- psych (5.4.0)
45
+ psych (5.5.0)
46
46
  date
47
47
  stringio
48
48
  racc (1.8.1)
@@ -101,7 +101,7 @@ CHECKSUMS
101
101
  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
102
102
  byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
103
103
  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
104
- cybrid_api_bank_ruby (0.129.899)
104
+ cybrid_api_bank_ruby (0.129.1022)
105
105
  date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
106
106
  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
107
107
  ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
@@ -124,7 +124,7 @@ CHECKSUMS
124
124
  parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
125
125
  pry (0.16.0) sha256=d76c69065698ed1f85e717bd33d7942c38a50868f6b0673c636192b3d1b6054e
126
126
  pry-byebug (3.12.0) sha256=594e094ae8a8390a7ad4c7b36ae36e13304ed02664c67417d108dc5f7213d1b7
127
- psych (5.4.0) sha256=14f72d69a611af663d7d70e4a7b67d9eb1f3ae9f8d916b478961d5a0075ba5b7
127
+ psych (5.5.0) sha256=4b245bbbd0f3238df8ccee766ebc1a6b062b10e4ee1d3284eb588739ba156a0a
128
128
  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
129
129
  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
130
130
  rake (13.0.6) sha256=5ce4bf5037b4196c24ac62834d8db1ce175470391026bd9e557d669beeb19097
data/README.md CHANGED
@@ -151,8 +151,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
151
151
 
152
152
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
153
153
 
154
- - API version: v0.129.899
155
- - Package version: 0.129.899
154
+ - API version: v0.129.1022
155
+ - Package version: 0.129.1022
156
156
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
157
157
 
158
158
  ## Installation
@@ -168,16 +168,16 @@ gem build cybrid_api_bank_ruby.gemspec
168
168
  Then either install the gem locally:
169
169
 
170
170
  ```shell
171
- gem install ./cybrid_api_bank_ruby-0.129.899.gem
171
+ gem install ./cybrid_api_bank_ruby-0.129.1022.gem
172
172
  ```
173
173
 
174
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.899.gem` to install the development dependencies)
174
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.1022.gem` to install the development dependencies)
175
175
 
176
176
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
177
177
 
178
178
  Finally add this to the Gemfile:
179
179
 
180
- gem 'cybrid_api_bank_ruby', '~> 0.129.899'
180
+ gem 'cybrid_api_bank_ruby', '~> 0.129.1022'
181
181
 
182
182
  ### Install from Git
183
183
 
@@ -405,6 +405,7 @@ Class | Method | HTTP request | Description
405
405
  - [CybridApiBank::PatchTransferParticipantBankModel](docs/PatchTransferParticipantBankModel.md)
406
406
  - [CybridApiBank::PaymentInstructionBankModel](docs/PaymentInstructionBankModel.md)
407
407
  - [CybridApiBank::PaymentInstructionListBankModel](docs/PaymentInstructionListBankModel.md)
408
+ - [CybridApiBank::PayoutReturnDetailsBankModel](docs/PayoutReturnDetailsBankModel.md)
408
409
  - [CybridApiBank::PersonaSessionBankModel](docs/PersonaSessionBankModel.md)
409
410
  - [CybridApiBank::PhysicalAddressBankModel](docs/PhysicalAddressBankModel.md)
410
411
  - [CybridApiBank::PlanBankModel](docs/PlanBankModel.md)
data/cybrid_api_bank_ruby.gemspec CHANGED
@@ -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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), 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://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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:read bank_applications:write bank_applications:execute accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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.129.899
8
+ The version of the OpenAPI document: v0.129.1022
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
data/docs/ActivityLimitBankModel.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | The type of the limit; one of rolling, daily, weekly, or monthly. | [optional] |
7
+ | **type** | **String** | The type of the limit; one of rolling, daily, weekly, monthly, or lifetime. | [optional] |
8
8
  | **name** | **String** | The name of the limit. | [optional] |
9
9
  | **asset** | **String** | The asset code for the limit. | [optional] |
10
10
  | **amount** | **Integer** | The limit amount for the asset. | [optional] |
data/docs/ComplianceCheckBankModel.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | The type of compliance check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested. | |
7
+ | **type** | **String** | The type of compliance check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_bank_authentication, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested. | |
8
8
  | **outcome** | **String** | The outcome of the compliance check; one of passed, failed, insufficient, or inconclusive. | |
9
9
  | **failure_codes** | **Array&lt;String&gt;** | The reason codes explaining the outcome. | [optional] |
10
10
 
data/docs/ComplianceDecisionBankModel.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested. | |
7
+ | **type** | **String** | The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_bank_authentication, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested. | |
8
8
  | **state** | **String** | The state of the verification check; one of passed, failed, expired, or invalidated. | |
9
9
  | **failure_codes** | **Array&lt;String&gt;** | The reason codes explaining the outcome. | [optional] |
10
10
  | **expired_at** | **Time** | ISO8601 datetime the compliance decision is expired. | [optional] |
data/docs/ExecutionBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the quote. | |
8
- | **type** | **String** | The type of product the plan is for; one of remittance, deposit_return, or withdrawal_return. | |
8
+ | **type** | **String** | The type of product the plan is for; one of remittance, bill_pay, disbursement, invoice_pay, deposit_return, withdrawal_return, or payout_return. | |
9
9
  | **plan_guid** | **String** | The unique identifier for the plan. | |
10
10
  | **bank_guid** | **String** | The unique identifier for the bank. | [optional] |
11
11
  | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
@@ -21,7 +21,7 @@
21
21
  | **holds** | [**Array&lt;HoldDetailBankModel&gt;**](HoldDetailBankModel.md) | The holds placed on the execution. | [optional] |
22
22
  | **travel_rule_info** | [**ExecutionTravelRuleInfoBankModel**](ExecutionTravelRuleInfoBankModel.md) | | |
23
23
  | **purpose_of_transaction** | **String** | The purpose of transaction for the execution. | [optional] |
24
- | **references** | [**Array&lt;PlanReferenceBankModel&gt;**](PlanReferenceBankModel.md) | Objects this return execution references (the returned execution and stage). Optional when type is deposit_return or type is withdrawal_return. | [optional] |
24
+ | **references** | [**Array&lt;PlanReferenceBankModel&gt;**](PlanReferenceBankModel.md) | Objects this return execution references (the returned execution and stage). Optional when type is deposit_return, type is withdrawal_return, or type is payout_return. | [optional] |
25
25
  | **labels** | **Array&lt;String&gt;** | The labels associated with the execution. | [optional] |
26
26
 
27
27
  ## Example
data/docs/IdentityVerificationBankModel.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
8
8
  | **type** | **String** | The identity verification type; one of kyc, bank_account, or counterparty. | [optional] |
9
- | **method** | **String** | The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, watchlists, attested_ownership, or account_ownership. | [optional] |
9
+ | **method** | **String** | The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, attested_database, watchlists, attested_ownership, or account_ownership. | [optional] |
10
10
  | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
11
11
  | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
12
12
  | **customer_guid** | **String** | The customer&#39;s identifier. | [optional] |
data/docs/IdentityVerificationWithDetailsBankModel.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
8
8
  | **type** | **String** | The identity verification type; one of kyc, bank_account, or counterparty. | [optional] |
9
- | **method** | **String** | The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, watchlists, attested_ownership, or account_ownership. | [optional] |
9
+ | **method** | **String** | The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, attested_database, watchlists, attested_ownership, or account_ownership. | [optional] |
10
10
  | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
11
11
  | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
12
12
  | **customer_guid** | **String** | The identity verification&#39;s identifier. | [optional] |
data/docs/IdentityVerificationWithDetailsPiiBankModel.md CHANGED
@@ -18,6 +18,8 @@
18
18
  | **business_industry** | **String** | The attested business industry. | [optional] |
19
19
  | **business_funds_source** | **String** | The attested business funds source. | [optional] |
20
20
  | **business_funds_destination** | **String** | The attested business funds destination. | [optional] |
21
+ | **business_type** | **String** | The attested business type. | [optional] |
22
+ | **business_incorporation_date** | **Date** | The attested business incorporation date. | [optional] |
21
23
  | **identification_numbers** | [**Array&lt;IdentificationNumberBankModel&gt;**](IdentificationNumberBankModel.md) | The attested identification numbers. | [optional] |
22
24
 
23
25
  ## Example
@@ -40,6 +42,8 @@ instance = CybridApiBank::IdentityVerificationWithDetailsPiiBankModel.new(
40
42
  business_industry: null,
41
43
  business_funds_source: null,
42
44
  business_funds_destination: null,
45
+ business_type: null,
46
+ business_incorporation_date: null,
43
47
  identification_numbers: null
44
48
  )
45
49
  ```
data/docs/PayoutReturnDetailsBankModel.md ADDED
@@ -0,0 +1,18 @@
1
+ # CybridApiBank::PayoutReturnDetailsBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **returned_at** | **Time** | The timestamp when the return was initiated by the provider. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'cybrid_api_bank_ruby'
13
+
14
+ instance = CybridApiBank::PayoutReturnDetailsBankModel.new(
15
+ returned_at: null
16
+ )
17
+ ```
18
+
data/docs/PlanBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the entity. | |
8
- | **type** | **String** | The type of product the plan is for; one of remittance, deposit_return, or withdrawal_return. | |
8
+ | **type** | **String** | The type of product the plan is for; one of remittance, bill_pay, disbursement, invoice_pay, deposit_return, withdrawal_return, or payout_return. | |
9
9
  | **bank_guid** | **String** | The unique identifier for the bank. | [optional] |
10
10
  | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
11
11
  | **created_at** | **Time** | ISO8601 datetime the record was created at. | |
@@ -20,7 +20,7 @@
20
20
  | **effective_rate** | [**EffectiveRateBankModel**](EffectiveRateBankModel.md) | | [optional] |
21
21
  | **travel_rule_info** | [**PlanTravelRuleInfoBankModel**](PlanTravelRuleInfoBankModel.md) | | |
22
22
  | **purpose_of_transaction** | **String** | The purpose of transaction for the plan. | [optional] |
23
- | **supporting_documents** | [**Array&lt;SupportingDocumentBankModel&gt;**](SupportingDocumentBankModel.md) | Supporting documents attached to the plan. Optional when type is remittance. | [optional] |
23
+ | **supporting_documents** | [**Array&lt;SupportingDocumentBankModel&gt;**](SupportingDocumentBankModel.md) | Supporting documents attached to the plan. Optional when type is remittance or type is invoice_pay. | [optional] |
24
24
  | **labels** | **Array&lt;String&gt;** | The labels associated with the plan. | [optional] |
25
25
 
26
26
  ## Example
data/docs/PostIdentityVerificationAddressBankModel.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **street** | **String** | The first line of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
8
- | **street2** | **String** | The optional second line of the address. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
9
- | **city** | **String** | The city of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
10
- | **subdivision** | **String** | The ISO 3166-2 subdivision code of the address. Applicable only for countries that use subnational states, provinces, lands, oblasts or regions. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
11
- | **postal_code** | **String** | The postal, zip or post code of the address. Applicable only for countries that use postal, zip or post codes. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
12
- | **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
7
+ | **street** | **String** | The first line of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
8
+ | **street2** | **String** | The optional second line of the address. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
9
+ | **city** | **String** | The city of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
10
+ | **subdivision** | **String** | The ISO 3166-2 subdivision code of the address. Applicable only for countries that use subnational states, provinces, lands, oblasts or regions. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
11
+ | **postal_code** | **String** | The postal, zip or post code of the address. Applicable only for countries that use postal, zip or post codes. Optional when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
12
+ | **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
13
13
 
14
14
  ## Example
15
15
 
data/docs/PostIdentityVerificationBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The type of identity verification. | |
8
- | **customer_guid** | **String** | The customer&#39;s identifier. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. | [optional] |
8
+ | **customer_guid** | **String** | The customer&#39;s identifier. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. | [optional] |
9
9
  | **expected_behaviours** | **Array&lt;String&gt;** | The optional expected behaviour to simulate. | [optional] |
10
10
  | **method** | **String** | The identity verification method. Required when type is counterparty, type is kyc, or type is bank_account. | [optional] |
11
11
  | **counterparty_guid** | **String** | The counterparty&#39;s identifier. Required when type is counterparty. | [optional] |
@@ -13,20 +13,22 @@
13
13
  | **require_tax_id** | **Boolean** | Whether the collection of the tax id is required during identity verification. This will default to SSN in USA and SIN in Canada. It&#39;s not used elsewhere. Optional when type is kyc and method is id_and_selfie. | [optional][default to false] |
14
14
  | **name** | [**PostIdentityVerificationNameBankModel**](PostIdentityVerificationNameBankModel.md) | | [optional] |
15
15
  | **address** | [**PostIdentityVerificationAddressBankModel**](PostIdentityVerificationAddressBankModel.md) | | [optional] |
16
- | **date_of_birth** | **Date** | The customer&#39;s date of birth. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. | [optional] |
17
- | **identification_numbers** | [**Array&lt;PostIdentificationNumberBankModel&gt;**](PostIdentificationNumberBankModel.md) | The customer&#39;s identification numbers. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is attested_id_and_selfie. | [optional] |
16
+ | **date_of_birth** | **Date** | The customer&#39;s date of birth. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. | [optional] |
17
+ | **identification_numbers** | [**Array&lt;PostIdentificationNumberBankModel&gt;**](PostIdentificationNumberBankModel.md) | The customer&#39;s identification numbers. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. Optional when type is kyc and method is attested_id_and_selfie. | [optional] |
18
18
  | **aliases** | [**Array&lt;PostIdentityVerificationAliasesInnerBankModel&gt;**](PostIdentityVerificationAliasesInnerBankModel.md) | The aliases of the customer. Optional when type is kyc and method is attested_business_registration or type is kyc and method is watchlists. | [optional] |
19
- | **phone_number** | **String** | The customer&#39;s phone number. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership. | [optional] |
20
- | **email_address** | **String** | The customer&#39;s email address. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership. | [optional] |
19
+ | **phone_number** | **String** | The customer&#39;s phone number. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. Optional when type is bank_account and method is attested_ownership. | [optional] |
20
+ | **email_address** | **String** | The customer&#39;s email address. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. Optional when type is bank_account and method is attested_ownership. | [optional] |
21
21
  | **website** | **String** | The customer&#39;s website. Required for attested business registration V2, optional for V3. Optional when type is kyc and method is attested_business_registration. | [optional] |
22
22
  | **nature_of_business** | **String** | The customer&#39;s nature of business. Required when type is kyc and method is attested_business_registration. | [optional] |
23
23
  | **director_customer_guids** | **Array&lt;String&gt;** | The customer guids of the directors of the business Required when type is kyc and method is attested_business_registration. | [optional] |
24
24
  | **ultimate_beneficial_owners** | [**Array&lt;PostUltimateBeneficialOwnerBankModel&gt;**](PostUltimateBeneficialOwnerBankModel.md) | The ultimate beneficial owners of the business with 25% or more ownership. Required for attested business registration V2, optional for V3. Optional when type is kyc and method is attested_business_registration. | [optional] |
25
25
  | **supporting_file_guids** | **Array&lt;String&gt;** | File guids supporting the verification Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is attested_id_and_selfie. | [optional] |
26
26
  | **registered_address** | [**PostIdentityVerificationRegisteredAddressBankModel**](PostIdentityVerificationRegisteredAddressBankModel.md) | | [optional] |
27
- | **business_industry** | **String** | The industry the business operates in. Required for attested business registration V3. e.g. &#39;Crypto / Digital Assets / Blockchain&#39;, &#39;Education&#39;, &#39;Gaming&#39;, &#39;Healthcare / Hospitality&#39;, &#39;Lending / Investments&#39;, &#39;Retail / E-Commerce&#39;, etc. Optional when type is kyc and method is attested_business_registration. | [optional] |
27
+ | **business_industry** | **String** | The industry the business operates in. Required for attested business registration V3. Optional when type is kyc and method is attested_business_registration. | [optional] |
28
28
  | **business_funds_source** | **String** | The source of business funds. Required for attested business registration V3. e.g. &#39;Funds from individual customers&#39;, &#39;Funds from business customers&#39;, &#39;Funds from both individual and business customers&#39;, etc. Optional when type is kyc and method is attested_business_registration. | [optional] |
29
29
  | **business_funds_destination** | **String** | The destination of business funds. Required for attested business registration V3. e.g. &#39;To your business account (bank or wallet)&#39;, &#39;To vendors or suppliers&#39;, &#39;To employees or contractors&#39;, &#39;To sellers or merchants&#39;, &#39;Bulk payments or payouts&#39;, etc. Optional when type is kyc and method is attested_business_registration. | [optional] |
30
+ | **business_type** | **String** | The type of business. Defaults to &#39;entity&#39; for V3. Optional when type is kyc and method is attested_business_registration. | [optional] |
31
+ | **business_incorporation_date** | **Date** | The date the business was incorporated. Required for attested business registration V3. Optional when type is kyc and method is attested_business_registration. | [optional] |
30
32
  | **occupation** | **String** | The customer&#39;s occupation. Required when type is kyc and method is attested_business_associate. Optional when type is kyc and method is attested_id_and_selfie. | [optional] |
31
33
  | **citizenship** | **String** | The customer&#39;s citizenship country code. Required when type is kyc and method is attested_business_associate. | [optional] |
32
34
  | **biometrics_verified** | **Boolean** | Whether biometrics have been verified Required when type is kyc and method is attested_business_associate or type is kyc and method is attested_id_and_database. | [optional] |
@@ -61,6 +63,8 @@ instance = CybridApiBank::PostIdentityVerificationBankModel.new(
61
63
  business_industry: null,
62
64
  business_funds_source: null,
63
65
  business_funds_destination: null,
66
+ business_type: null,
67
+ business_incorporation_date: null,
64
68
  occupation: null,
65
69
  citizenship: null,
66
70
  biometrics_verified: null,
data/docs/PostIdentityVerificationNameBankModel.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **first** | **String** | The customer&#39;s first name. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership. | [optional] |
8
- | **middle** | **String** | The customer&#39;s middle name. Optional when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
9
- | **last** | **String** | The customer&#39;s last name. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership. | [optional] |
10
- | **full** | **String** | The customer&#39;s full name. Required when type is kyc and method is attested_business_registration or type is bank_account and method is attested_ownership. Optional when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is watchlists. | [optional] |
7
+ | **first** | **String** | The customer&#39;s first name. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership. | [optional] |
8
+ | **middle** | **String** | The customer&#39;s middle name. Optional when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, type is kyc and method is watchlists, or type is bank_account and method is attested_ownership. | [optional] |
9
+ | **last** | **String** | The customer&#39;s last name. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is kyc and method is attested_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership. | [optional] |
10
+ | **full** | **String** | The customer&#39;s full name. Required when type is kyc and method is attested_business_registration or type is bank_account and method is attested_ownership. Optional when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, type is kyc and method is attested_database, or type is kyc and method is watchlists. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
data/docs/PostPlanBankModel.md CHANGED
@@ -12,7 +12,7 @@
12
12
  | **travel_rule_info** | [**PostPlanTravelRuleInfoBankModel**](PostPlanTravelRuleInfoBankModel.md) | | [optional] |
13
13
  | **purpose_of_transaction** | **String** | The purpose of transaction for the plan. | [optional] |
14
14
  | **labels** | **Array&lt;String&gt;** | The labels associated with the plan. | [optional] |
15
- | **supporting_documents** | [**Array&lt;PostSupportingDocumentBankModel&gt;**](PostSupportingDocumentBankModel.md) | Supporting documents to attach to the plan. Optional when type is remittance. | [optional] |
15
+ | **supporting_documents** | [**Array&lt;PostSupportingDocumentBankModel&gt;**](PostSupportingDocumentBankModel.md) | Supporting documents to attach to the plan. Optional when type is remittance or type is invoice_pay. | [optional] |
16
16
 
17
17
  ## Example
18
18
 
data/docs/QuoteBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the quote. | [optional] |
8
- | **product_type** | **String** | The type of product the quote is for; one of trading, trading_exit, funding, crypto_transfer, inter_account, lightning_transfer, or book_transfer. | [optional] |
8
+ | **product_type** | **String** | The type of product the quote is for; one of trading, funding, book_transfer, crypto_transfer, funding_return, trading_liquidation, crypto_transfer_return, loss_recovery_transfer, inter_account, lightning_transfer, trading_exit, loss_coverage_transfer, or loss_reclaim_transfer. | [optional] |
9
9
  | **bank_guid** | **String** | The unique identifier for the bank. | [optional] |
10
10
  | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
11
11
  | **symbol** | **String** | Symbol the quote was requested for. Format is \&quot;asset-counter_asset\&quot; in uppercase. Populated for trade quotes. | [optional] |
data/docs/StageBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | The unique identifier for the stage. | |
8
- | **type** | **String** | The type of stage; one of payout, deposit, withdrawal, trade, deposit_return, loss_recovery, or withdrawal_return. | |
8
+ | **type** | **String** | The type of stage; one of payout, deposit, withdrawal, trade, deposit_return, loss_recovery, withdrawal_return, or payout_return. | |
9
9
  | **state** | **String** | The state of the stage; one of storing, planning, planned, executing, completed, or failed. | |
10
10
  | **failure_code** | **String** | The failure code for failed stages. | [optional] |
11
11
  | **identifiers** | [**Array&lt;StageIdentifierBankModel&gt;**](StageIdentifierBankModel.md) | Provider-issued identifiers associated with this stage. Always present, possibly empty. | |
@@ -18,6 +18,7 @@
18
18
  | **effective_rate** | [**EffectiveRateBankModel**](EffectiveRateBankModel.md) | | [optional] |
19
19
  | **deposit_return_details** | [**ReturnDetailsBankModel**](ReturnDetailsBankModel.md) | | [optional] |
20
20
  | **withdrawal_return_details** | [**ReturnDetailsBankModel**](ReturnDetailsBankModel.md) | | [optional] |
21
+ | **payout_return_details** | [**PayoutReturnDetailsBankModel**](PayoutReturnDetailsBankModel.md) | | [optional] |
21
22
 
22
23
  ## Example
23
24
 
@@ -38,7 +39,8 @@ instance = CybridApiBank::StageBankModel.new(
38
39
  fees: null,
39
40
  effective_rate: null,
40
41
  deposit_return_details: null,
41
- withdrawal_return_details: null
42
+ withdrawal_return_details: null,
43
+ payout_return_details: null
42
44
  )
43
45
  ```
44
46
 
data/docs/TradeBankModel.md CHANGED
@@ -11,7 +11,7 @@
11
11
  | **symbol** | **String** | The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD. | [optional] |
12
12
  | **side** | **String** | The direction of the trade; one of buy or sell. | [optional] |
13
13
  | **state** | **String** | The state of the trade; one of storing, pending, executed, cancelled, completed, settling, or failed. | [optional] |
14
- | **failure_code** | **String** | The failure code for failed trades; one of non_sufficient_funds, unsupported, limit_exceeded, expired_quote, market_volatility, not_filled, daily_limit_exceeded, weekly_limit_exceeded, or monthly_limit_exceeded. | [optional] |
14
+ | **failure_code** | **String** | The failure code for failed trades; one of non_sufficient_funds, unsupported, limit_exceeded, expired_quote, market_volatility, not_filled, daily_limit_exceeded, weekly_limit_exceeded, monthly_limit_exceeded, or lifetime_limit_exceeded. | [optional] |
15
15
  | **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \&quot;asset\&quot; for buy and \&quot;counter_asset\&quot; for sell. | [optional] |
16
16
  | **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \&quot;counter_asset\&quot; for buy and \&quot;asset\&quot; for sell. | [optional] |
17
17
  | **fee** | **Integer** | The fee associated with the trade. Denominated in \&quot;counter_asset\&quot; base units. Represents the sum of the bank and platform fees. | [optional] |
data/docs/TradesBankApi.md CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://bank.sandbox.cybrid.app*
15
15
 
16
16
  Create Trade
17
17
 
18
- Creates a trade. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the trade details in our private store | | pending | The Platform has stored the trade details and is processing it | | executed | The Platform has processed the trade and needs to settle it | | settling | The Platform has executed the trade and is settling the funds | | cancelled | The Platform has cancelled the trade | | completed | The Platform has successfully completed the trade | | failed | The Platform was not able to successfully complete the trade | ## Failure codes | Code | Description | |------|-------------| | non_sufficient_funds | The delivery account does not have enough funds to complete the trade | | unsupported | The trading pair is not supported for this customer | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | daily_limit_exceeded | The customer is over their daily limits for this activity | | weekly_limit_exceeded | The customer is over their weekly limits for this activity | | monthly_limit_exceeded | The customer is over their monthly limits for this activity | | expired_quote | The quote expired before it could be executed | | market_volatility | The quote could not be executed due to market volatility | | not_filled | The trade could not be filled based on the amounts specified | Required scope: **trades:execute**
18
+ Creates a trade. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the trade details in our private store | | pending | The Platform has stored the trade details and is processing it | | executed | The Platform has processed the trade and needs to settle it | | settling | The Platform has executed the trade and is settling the funds | | cancelled | The Platform has cancelled the trade | | completed | The Platform has successfully completed the trade | | failed | The Platform was not able to successfully complete the trade | ## Failure codes | Code | Description | |------|-------------| | non_sufficient_funds | The delivery account does not have enough funds to complete the trade | | unsupported | The trading pair is not supported for this customer | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | daily_limit_exceeded | The customer is over their daily limits for this activity | | weekly_limit_exceeded | The customer is over their weekly limits for this activity | | monthly_limit_exceeded | The customer is over their monthly limits for this activity | | lifetime_limit_exceeded | The customer is over their lifetime limits for this activity | | expired_quote | The quote expired before it could be executed | | market_volatility | The quote could not be executed due to market volatility | | not_filled | The trade could not be filled based on the amounts specified | Required scope: **trades:execute**
19
19
 
20
20
  ### Examples
21
21
 
data/docs/TransferBankModel.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the transfer. | [optional] |
8
- | **transfer_type** | **String** | The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, or instant_funding_return. | [optional] |
8
+ | **transfer_type** | **String** | The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, instant_funding_return, loss_coverage, or loss_reclaim. | [optional] |
9
9
  | **bank_guid** | **String** | The associated bank&#39;s identifier. | [optional] |
10
10
  | **customer_guid** | **String** | The associated customer&#39;s identifier. | [optional] |
11
11
  | **quote_guid** | **String** | The associated quote&#39;s identifier. | [optional] |
@@ -13,7 +13,7 @@
13
13
  | **asset** | **String** | The asset the transfer is related to, e.g., USD. | [optional] |
14
14
  | **side** | **String** | The direction of the quote; one of deposit or withdrawal. | [optional] |
15
15
  | **state** | **String** | The state of the transfer; one of storing, pending, holding, reviewing, completed, failed, or cancelling. | [optional] |
16
- | **failure_code** | **String** | The failure code for failed transfers; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, invalid_address, invalid_destination, customer_action_required, external_vendor_error, payment_request_expired, return_risk_exceeded, daily_limit_exceeded, weekly_limit_exceeded, monthly_limit_exceeded, customer_contact_info_missing, or recipient_cancelled. | [optional] |
16
+ | **failure_code** | **String** | The failure code for failed transfers; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, invalid_address, invalid_destination, customer_action_required, external_vendor_error, payment_request_expired, return_risk_exceeded, daily_limit_exceeded, weekly_limit_exceeded, monthly_limit_exceeded, lifetime_limit_exceeded, customer_contact_info_missing, or recipient_cancelled. | [optional] |
17
17
  | **return_code** | **String** | The return code for reversed transfers | [optional] |
18
18
  | **amount** | **Integer** | The actual amount in base units of the asset. | [optional] |
19
19
  | **estimated_amount** | **Integer** | The estimated amount in base units of the asset. | [optional] |
data/docs/TransfersBankApi.md CHANGED
@@ -91,7 +91,7 @@ end
91
91
 
92
92
  Create Transfer
93
93
 
94
- Creates a transfer. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the transfer details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |------|-------------| | amount_too_low | The transfer was rejected due to the amount being too low | | cancelled | The transfer was manually cancelled | | compliance_rejection | The transfer was rejected for compliance reasons | | internal_error | An internal error occurred while processing the transfer, please try again | | invalid_address | The destination address is invalid for transfer | | invalid_balance | There was insufficient balance for all required currencies to complete the transfer | | return_risk_exceeded | The risk of return is too high for this activity to be completed | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | daily_limit_exceeded | The customer is over their daily limits for this activity | | weekly_limit_exceeded | The customer is over their weekly limits for this activity | | monthly_limit_exceeded | The customer is over their monthly limits for this activity | | network_fee_too_low | The transfer was rejected due to the network fee being too low | | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | party_name_invalid | The transfer's associated external bank account has an invalid party name | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | | payment_request_expired | The payment request expired before it could be completed | | plaid_access_not_granted | See the description from Plaid [here](https://plaid.com/docs/errors/item/#access_not_granted) | | plaid_institution_not_responding | See the description from Plaid [here](https://plaid.com/docs/errors/institution/#institution_not_responding) | | plaid_internal_server_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error) | | plaid_item_not_found | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_found) | | plaid_item_not_supported | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_supported) | | plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. | | plaid_no_accounts | See the description from Plaid [here](https://plaid.com/docs/errors/item/#no_accounts) | | plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid | | plaid_unknown_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#unknown_error) | | refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid | | invalid_destination | Issues with the destination details (invalid, closed, blocked) | | customer_action_required | Authorization declined or customer action required | | external_vendor_error | Unexpected error occurred with an external vendor or partner service during transfer processing | | reversed | The transfer was reversed | ## Failure codes that will result in a state change for the associated external bank account | Code | Description | |------|-------------| | refresh_required | The transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state `refresh_required` | | plaid_access_not_granted | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_found | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_supported | The transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state `deleted` | | plaid_multiple_accounts | The transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state `deleted` | | plaid_no_accounts | The transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state `deleted` | Required scope: **transfers:execute**
94
+ Creates a transfer. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the transfer details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |------|-------------| | amount_too_low | The transfer was rejected due to the amount being too low | | cancelled | The transfer was manually cancelled | | compliance_rejection | The transfer was rejected for compliance reasons | | internal_error | An internal error occurred while processing the transfer, please try again | | invalid_address | The destination address is invalid for transfer | | invalid_balance | There was insufficient balance for all required currencies to complete the transfer | | return_risk_exceeded | The risk of return is too high for this activity to be completed | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | daily_limit_exceeded | The customer is over their daily limits for this activity | | weekly_limit_exceeded | The customer is over their weekly limits for this activity | | monthly_limit_exceeded | The customer is over their monthly limits for this activity | | lifetime_limit_exceeded | The customer is over their lifetime limits for this activity | | network_fee_too_low | The transfer was rejected due to the network fee being too low | | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | party_name_invalid | The transfer's associated external bank account has an invalid party name | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | | payment_request_expired | The payment request expired before it could be completed | | plaid_access_not_granted | See the description from Plaid [here](https://plaid.com/docs/errors/item/#access_not_granted) | | plaid_institution_not_responding | See the description from Plaid [here](https://plaid.com/docs/errors/institution/#institution_not_responding) | | plaid_internal_server_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error) | | plaid_item_not_found | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_found) | | plaid_item_not_supported | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_supported) | | plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. | | plaid_no_accounts | See the description from Plaid [here](https://plaid.com/docs/errors/item/#no_accounts) | | plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid | | plaid_unknown_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#unknown_error) | | refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid | | invalid_destination | Issues with the destination details (invalid, closed, blocked) | | customer_action_required | Authorization declined or customer action required | | external_vendor_error | Unexpected error occurred with an external vendor or partner service during transfer processing | | reversed | The transfer was reversed | ## Failure codes that will result in a state change for the associated external bank account | Code | Description | |------|-------------| | refresh_required | The transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state `refresh_required` | | plaid_access_not_granted | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_found | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_supported | The transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state `deleted` | | plaid_multiple_accounts | The transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state `deleted` | | plaid_no_accounts | The transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state `deleted` | Required scope: **transfers:execute**
95
95
 
96
96
  ### Examples
97
97
 
data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb CHANGED
@@ -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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), 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://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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:read bank_applications:write bank_applications:execute accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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.129.899
6
+ The version of the OpenAPI document: v0.129.1022
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0