cybrid_api_bank_ruby 0.129.692 → 0.129.694
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +7 -5
- data/cybrid_api_bank_ruby.gemspec +1 -1
- data/docs/AccountsBankApi.md +86 -5
- data/docs/PatchAccountBankModel.md +18 -0
- data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +81 -1
- data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
- data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
- data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_account_bank_model.rb +246 -0
- data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_external_wallet_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/plan_reference_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/return_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
- data/lib/cybrid_api_bank_ruby/version.rb +2 -2
- data/lib/cybrid_api_bank_ruby.rb +2 -1
- data/spec/api/accounts_bank_api_spec.rb +16 -1
- data/spec/api/assets_bank_api_spec.rb +1 -1
- data/spec/api/banks_bank_api_spec.rb +1 -1
- data/spec/api/counterparties_bank_api_spec.rb +1 -1
- data/spec/api/customers_bank_api_spec.rb +1 -1
- data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
- data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
- data/spec/api/executions_bank_api_spec.rb +1 -1
- data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
- data/spec/api/external_wallets_bank_api_spec.rb +1 -1
- data/spec/api/files_bank_api_spec.rb +1 -1
- data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
- data/spec/api/invoices_bank_api_spec.rb +1 -1
- data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
- data/spec/api/persona_sessions_bank_api_spec.rb +1 -1
- data/spec/api/plans_bank_api_spec.rb +1 -1
- data/spec/api/prices_bank_api_spec.rb +1 -1
- data/spec/api/quotes_bank_api_spec.rb +1 -1
- data/spec/api/sardine_sessions_bank_api_spec.rb +1 -1
- data/spec/api/symbols_bank_api_spec.rb +1 -1
- data/spec/api/trades_bank_api_spec.rb +1 -1
- data/spec/api/transfers_bank_api_spec.rb +1 -1
- data/spec/api/workflows_bank_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_association_bank_model_spec.rb +1 -1
- data/spec/models/account_bank_model_spec.rb +1 -1
- data/spec/models/account_list_bank_model_spec.rb +1 -1
- data/spec/models/account_state_bank_model_spec.rb +1 -1
- data/spec/models/account_type_bank_model_spec.rb +1 -1
- data/spec/models/activity_limit_bank_model_spec.rb +1 -1
- data/spec/models/activity_side_bank_model_spec.rb +1 -1
- data/spec/models/activity_type_bank_model_spec.rb +1 -1
- data/spec/models/asset_bank_model_spec.rb +1 -1
- data/spec/models/asset_list_bank_model_spec.rb +1 -1
- data/spec/models/asset_types_bank_model_spec.rb +1 -1
- data/spec/models/bank_bank_model_spec.rb +1 -1
- data/spec/models/bank_feature_bank_model_spec.rb +1 -1
- data/spec/models/bank_list_bank_model_spec.rb +1 -1
- data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +1 -1
- data/spec/models/bank_type_bank_model_spec.rb +1 -1
- data/spec/models/compliance_check_bank_model_spec.rb +1 -1
- data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
- data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
- data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
- data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
- data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
- data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
- data/spec/models/customer_address_bank_model_spec.rb +1 -1
- data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/customer_bank_model_spec.rb +1 -1
- data/spec/models/customer_list_bank_model_spec.rb +1 -1
- data/spec/models/customer_name_bank_model_spec.rb +1 -1
- data/spec/models/customer_state_bank_model_spec.rb +1 -1
- data/spec/models/customer_type_bank_model_spec.rb +1 -1
- data/spec/models/deposit_address_bank_model_spec.rb +1 -1
- data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
- data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
- data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
- data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
- data/spec/models/error_response_bank_model_spec.rb +1 -1
- data/spec/models/execution_bank_model_spec.rb +1 -1
- data/spec/models/execution_list_bank_model_spec.rb +1 -1
- data/spec/models/execution_travel_rule_info_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +1 -1
- data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
- data/spec/models/external_wallet_bank_model_spec.rb +1 -1
- data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
- data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
- data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
- data/spec/models/fee_association_bank_model_spec.rb +1 -1
- data/spec/models/fee_detail_bank_model_spec.rb +1 -1
- data/spec/models/hold_detail_bank_model_spec.rb +1 -1
- data/spec/models/identification_number_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_business_associate_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_document_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_document_file_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_options_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
- data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +1 -1
- data/spec/models/invoice_bank_model_spec.rb +1 -1
- data/spec/models/invoice_list_bank_model_spec.rb +1 -1
- data/spec/models/legal_entity_name_bank_model_spec.rb +1 -1
- data/spec/models/patch_account_bank_model_spec.rb +34 -0
- data/spec/models/patch_bank_bank_model_spec.rb +1 -1
- data/spec/models/patch_customer_bank_model_spec.rb +1 -1
- data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
- data/spec/models/patch_external_wallet_bank_model_spec.rb +1 -1
- data/spec/models/patch_transfer_bank_model_spec.rb +1 -1
- data/spec/models/patch_transfer_participant_bank_model_spec.rb +1 -1
- data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
- data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
- data/spec/models/persona_session_bank_model_spec.rb +1 -1
- data/spec/models/physical_address_bank_model_spec.rb +1 -1
- data/spec/models/plan_bank_model_spec.rb +1 -1
- data/spec/models/plan_list_bank_model_spec.rb +1 -1
- data/spec/models/plan_reference_bank_model_spec.rb +1 -1
- data/spec/models/plan_travel_rule_info_bank_model_spec.rb +1 -1
- data/spec/models/platform_file_bank_model_spec.rb +1 -1
- data/spec/models/platform_file_list_bank_model_spec.rb +1 -1
- data/spec/models/post_account_bank_model_spec.rb +1 -1
- data/spec/models/post_bank_account_details_bank_model_spec.rb +1 -1
- data/spec/models/post_bank_bank_model_spec.rb +1 -1
- data/spec/models/post_counterparty_address_bank_model_spec.rb +1 -1
- data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/post_counterparty_bank_model_spec.rb +1 -1
- data/spec/models/post_counterparty_name_bank_model_spec.rb +1 -1
- data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
- data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/post_customer_bank_model_spec.rb +1 -1
- data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
- data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
- data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
- data/spec/models/post_execution_bank_model_spec.rb +1 -1
- data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
- data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
- data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
- data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
- data/spec/models/post_fee_bank_model_spec.rb +1 -1
- data/spec/models/post_file_bank_model_spec.rb +1 -1
- data/spec/models/post_file_metadata_bank_model_spec.rb +1 -1
- data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
- data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +1 -1
- data/spec/models/post_invoice_bank_model_spec.rb +1 -1
- data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
- data/spec/models/post_persona_session_bank_model_spec.rb +1 -1
- data/spec/models/post_plan_bank_model_spec.rb +1 -1
- data/spec/models/post_plan_destination_account_bank_model_spec.rb +1 -1
- data/spec/models/post_plan_source_account_bank_model_spec.rb +1 -1
- data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +1 -1
- data/spec/models/post_quote_bank_model_spec.rb +1 -1
- data/spec/models/post_quote_entry_bank_model_spec.rb +1 -1
- data/spec/models/post_sardine_session_bank_model_spec.rb +1 -1
- data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +1 -1
- data/spec/models/post_supporting_document_bank_model_spec.rb +1 -1
- data/spec/models/post_trade_bank_model_spec.rb +1 -1
- data/spec/models/post_transfer_bank_model_spec.rb +1 -1
- data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
- data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +1 -1
- data/spec/models/post_workflow_bank_model_spec.rb +1 -1
- data/spec/models/quote_bank_model_spec.rb +1 -1
- data/spec/models/quote_entry_bank_model_spec.rb +1 -1
- data/spec/models/quote_entry_destination_account_bank_model_spec.rb +1 -1
- data/spec/models/quote_entry_source_account_bank_model_spec.rb +1 -1
- data/spec/models/quote_list_bank_model_spec.rb +1 -1
- data/spec/models/quote_side_bank_model_spec.rb +1 -1
- data/spec/models/quote_type_bank_model_spec.rb +1 -1
- data/spec/models/return_details_bank_model_spec.rb +1 -1
- data/spec/models/sardine_session_bank_model_spec.rb +1 -1
- data/spec/models/stage_bank_model_spec.rb +1 -1
- data/spec/models/stage_identifier_bank_model_spec.rb +1 -1
- data/spec/models/stage_link_bank_model_spec.rb +1 -1
- data/spec/models/supporting_document_bank_model_spec.rb +1 -1
- data/spec/models/supporting_document_file_bank_model_spec.rb +1 -1
- data/spec/models/symbol_price_bank_model_spec.rb +1 -1
- data/spec/models/trade_bank_model_spec.rb +1 -1
- data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
- data/spec/models/trade_list_bank_model_spec.rb +1 -1
- data/spec/models/trade_side_bank_model_spec.rb +1 -1
- data/spec/models/trade_state_bank_model_spec.rb +1 -1
- data/spec/models/trade_type_bank_model_spec.rb +1 -1
- data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
- data/spec/models/transfer_bank_model_spec.rb +1 -1
- data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
- data/spec/models/transfer_entry_bank_model_spec.rb +1 -1
- data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +1 -1
- data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
- data/spec/models/transfer_hold_details_bank_model_spec.rb +1 -1
- data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +1 -1
- data/spec/models/transfer_list_bank_model_spec.rb +1 -1
- data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
- data/spec/models/transfer_side_bank_model_spec.rb +1 -1
- data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
- data/spec/models/transfer_state_bank_model_spec.rb +1 -1
- data/spec/models/transfer_type_bank_model_spec.rb +1 -1
- data/spec/models/travel_rule_info_party_bank_model_spec.rb +1 -1
- data/spec/models/workflow_bank_model_spec.rb +1 -1
- data/spec/models/workflow_state_bank_model_spec.rb +1 -1
- data/spec/models/workflow_type_bank_model_spec.rb +1 -1
- data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
- data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
- data/spec/models/workflows_list_bank_model_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.8.2/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.4.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
- metadata +5 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ab1ea6bc3997846b26811accaafda4a76258a68e928efee1d121d508301ae1ee
|
|
4
|
+
data.tar.gz: 3795354ab6062615475a31aef652763aecba6d1adeb90dd16bfdc903d831c349
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4faa11b1b47cc3a5ad631b0eb84b301a1d51ea8dfd160c23788e98b39142287f0c619ccd8534b48a93307d11879582d3735b23a6a0cd76f8fa87e714bdb5daf1
|
|
7
|
+
data.tar.gz: ae04710b69fce0ca28ea9bcb2ddd10b0ded950525cdb09bbaef104c63548597b1c166ab1113dc6d8b66d48d7790ec5281dd6770e8a88d39c26e80d9d14c03422
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
cybrid_api_bank_ruby (0.129.
|
|
4
|
+
cybrid_api_bank_ruby (0.129.694)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -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.
|
|
104
|
+
cybrid_api_bank_ruby (0.129.694)
|
|
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
|
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.
|
|
155
|
-
- Package version: 0.129.
|
|
154
|
+
- API version: v0.129.694
|
|
155
|
+
- Package version: 0.129.694
|
|
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.
|
|
171
|
+
gem install ./cybrid_api_bank_ruby-0.129.694.gem
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
-
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.
|
|
174
|
+
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.694.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.
|
|
180
|
+
gem 'cybrid_api_bank_ruby', '~> 0.129.694'
|
|
181
181
|
|
|
182
182
|
### Install from Git
|
|
183
183
|
|
|
@@ -232,6 +232,7 @@ Class | Method | HTTP request | Description
|
|
|
232
232
|
*CybridApiBank::AccountsBankApi* | [**create_account**](docs/AccountsBankApi.md#create_account) | **POST** /api/accounts | Create Account
|
|
233
233
|
*CybridApiBank::AccountsBankApi* | [**get_account**](docs/AccountsBankApi.md#get_account) | **GET** /api/accounts/{account_guid} | Get Account
|
|
234
234
|
*CybridApiBank::AccountsBankApi* | [**list_accounts**](docs/AccountsBankApi.md#list_accounts) | **GET** /api/accounts | List Accounts
|
|
235
|
+
*CybridApiBank::AccountsBankApi* | [**update_account**](docs/AccountsBankApi.md#update_account) | **PATCH** /api/accounts/{account_guid} | Patch Account
|
|
235
236
|
*CybridApiBank::AssetsBankApi* | [**list_assets**](docs/AssetsBankApi.md#list_assets) | **GET** /api/assets | Get assets list
|
|
236
237
|
*CybridApiBank::BanksBankApi* | [**create_bank**](docs/BanksBankApi.md#create_bank) | **POST** /api/banks | Create Bank
|
|
237
238
|
*CybridApiBank::BanksBankApi* | [**get_bank**](docs/BanksBankApi.md#get_bank) | **GET** /api/banks/{bank_guid} | Get Bank
|
|
@@ -390,6 +391,7 @@ Class | Method | HTTP request | Description
|
|
|
390
391
|
- [CybridApiBank::InvoiceBankModel](docs/InvoiceBankModel.md)
|
|
391
392
|
- [CybridApiBank::InvoiceListBankModel](docs/InvoiceListBankModel.md)
|
|
392
393
|
- [CybridApiBank::LegalEntityNameBankModel](docs/LegalEntityNameBankModel.md)
|
|
394
|
+
- [CybridApiBank::PatchAccountBankModel](docs/PatchAccountBankModel.md)
|
|
393
395
|
- [CybridApiBank::PatchBankBankModel](docs/PatchBankBankModel.md)
|
|
394
396
|
- [CybridApiBank::PatchCustomerBankModel](docs/PatchCustomerBankModel.md)
|
|
395
397
|
- [CybridApiBank::PatchExternalBankAccountBankModel](docs/PatchExternalBankAccountBankModel.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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 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:execute deposit_bank_accounts:read 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 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_bank_accounts:read 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.
|
|
8
|
+
The version of the OpenAPI document: v0.129.694
|
|
9
9
|
Contact: support@cybrid.app
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
OpenAPI Generator version: 6.0.0
|
data/docs/AccountsBankApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://bank.sandbox.cybrid.app*
|
|
|
7
7
|
| [**create_account**](AccountsBankApi.md#create_account) | **POST** /api/accounts | Create Account |
|
|
8
8
|
| [**get_account**](AccountsBankApi.md#get_account) | **GET** /api/accounts/{account_guid} | Get Account |
|
|
9
9
|
| [**list_accounts**](AccountsBankApi.md#list_accounts) | **GET** /api/accounts | List Accounts |
|
|
10
|
+
| [**update_account**](AccountsBankApi.md#update_account) | **PATCH** /api/accounts/{account_guid} | Patch Account |
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
## create_account
|
|
@@ -83,7 +84,7 @@ end
|
|
|
83
84
|
|
|
84
85
|
## get_account
|
|
85
86
|
|
|
86
|
-
> <AccountBankModel> get_account(account_guid)
|
|
87
|
+
> <AccountBankModel> get_account(account_guid, opts)
|
|
87
88
|
|
|
88
89
|
Get Account
|
|
89
90
|
|
|
@@ -105,10 +106,13 @@ end
|
|
|
105
106
|
|
|
106
107
|
api_instance = CybridApiBank::AccountsBankApi.new
|
|
107
108
|
account_guid = 'account_guid_example' # String | Identifier for the account.
|
|
109
|
+
opts = {
|
|
110
|
+
include_balances: true # Boolean | Whether to include account balances in the response.
|
|
111
|
+
}
|
|
108
112
|
|
|
109
113
|
begin
|
|
110
114
|
# Get Account
|
|
111
|
-
result = api_instance.get_account(account_guid)
|
|
115
|
+
result = api_instance.get_account(account_guid, opts)
|
|
112
116
|
p result
|
|
113
117
|
rescue CybridApiBank::ApiError => e
|
|
114
118
|
puts "Error when calling AccountsBankApi->get_account: #{e}"
|
|
@@ -119,12 +123,12 @@ end
|
|
|
119
123
|
|
|
120
124
|
This returns an Array which contains the response data, status code and headers.
|
|
121
125
|
|
|
122
|
-
> <Array(<AccountBankModel>, Integer, Hash)> get_account_with_http_info(account_guid)
|
|
126
|
+
> <Array(<AccountBankModel>, Integer, Hash)> get_account_with_http_info(account_guid, opts)
|
|
123
127
|
|
|
124
128
|
```ruby
|
|
125
129
|
begin
|
|
126
130
|
# Get Account
|
|
127
|
-
data, status_code, headers = api_instance.get_account_with_http_info(account_guid)
|
|
131
|
+
data, status_code, headers = api_instance.get_account_with_http_info(account_guid, opts)
|
|
128
132
|
p status_code # => 2xx
|
|
129
133
|
p headers # => { ... }
|
|
130
134
|
p data # => <AccountBankModel>
|
|
@@ -138,6 +142,7 @@ end
|
|
|
138
142
|
| Name | Type | Description | Notes |
|
|
139
143
|
| ---- | ---- | ----------- | ----- |
|
|
140
144
|
| **account_guid** | **String** | Identifier for the account. | |
|
|
145
|
+
| **include_balances** | **Boolean** | Whether to include account balances in the response. | [optional] |
|
|
141
146
|
|
|
142
147
|
### Return type
|
|
143
148
|
|
|
@@ -184,7 +189,8 @@ opts = {
|
|
|
184
189
|
type: 'type_example', # String | Comma separated account_types to list accounts for.
|
|
185
190
|
bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list accounts for.
|
|
186
191
|
customer_guid: 'customer_guid_example', # String | Comma separated customer_guids to list accounts for.
|
|
187
|
-
label: 'label_example' # String | Comma separated labels to list accounts for.
|
|
192
|
+
label: 'label_example', # String | Comma separated labels to list accounts for.
|
|
193
|
+
include_balances: true # Boolean | Whether to include account balances in the response.
|
|
188
194
|
}
|
|
189
195
|
|
|
190
196
|
begin
|
|
@@ -226,6 +232,7 @@ end
|
|
|
226
232
|
| **bank_guid** | **String** | Comma separated bank_guids to list accounts for. | [optional] |
|
|
227
233
|
| **customer_guid** | **String** | Comma separated customer_guids to list accounts for. | [optional] |
|
|
228
234
|
| **label** | **String** | Comma separated labels to list accounts for. | [optional] |
|
|
235
|
+
| **include_balances** | **Boolean** | Whether to include account balances in the response. | [optional] |
|
|
229
236
|
|
|
230
237
|
### Return type
|
|
231
238
|
|
|
@@ -240,3 +247,77 @@ end
|
|
|
240
247
|
- **Content-Type**: Not defined
|
|
241
248
|
- **Accept**: application/json
|
|
242
249
|
|
|
250
|
+
|
|
251
|
+
## update_account
|
|
252
|
+
|
|
253
|
+
> <AccountBankModel> update_account(account_guid, patch_account_bank_model)
|
|
254
|
+
|
|
255
|
+
Patch Account
|
|
256
|
+
|
|
257
|
+
Updates an account. Required scope: **accounts:write**
|
|
258
|
+
|
|
259
|
+
### Examples
|
|
260
|
+
|
|
261
|
+
```ruby
|
|
262
|
+
require 'time'
|
|
263
|
+
require 'cybrid_api_bank_ruby'
|
|
264
|
+
# setup authorization
|
|
265
|
+
CybridApiBank.configure do |config|
|
|
266
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
267
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
268
|
+
|
|
269
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
270
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
api_instance = CybridApiBank::AccountsBankApi.new
|
|
274
|
+
account_guid = 'account_guid_example' # String | Identifier for the account.
|
|
275
|
+
patch_account_bank_model = CybridApiBank::PatchAccountBankModel.new # PatchAccountBankModel |
|
|
276
|
+
|
|
277
|
+
begin
|
|
278
|
+
# Patch Account
|
|
279
|
+
result = api_instance.update_account(account_guid, patch_account_bank_model)
|
|
280
|
+
p result
|
|
281
|
+
rescue CybridApiBank::ApiError => e
|
|
282
|
+
puts "Error when calling AccountsBankApi->update_account: #{e}"
|
|
283
|
+
end
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
#### Using the update_account_with_http_info variant
|
|
287
|
+
|
|
288
|
+
This returns an Array which contains the response data, status code and headers.
|
|
289
|
+
|
|
290
|
+
> <Array(<AccountBankModel>, Integer, Hash)> update_account_with_http_info(account_guid, patch_account_bank_model)
|
|
291
|
+
|
|
292
|
+
```ruby
|
|
293
|
+
begin
|
|
294
|
+
# Patch Account
|
|
295
|
+
data, status_code, headers = api_instance.update_account_with_http_info(account_guid, patch_account_bank_model)
|
|
296
|
+
p status_code # => 2xx
|
|
297
|
+
p headers # => { ... }
|
|
298
|
+
p data # => <AccountBankModel>
|
|
299
|
+
rescue CybridApiBank::ApiError => e
|
|
300
|
+
puts "Error when calling AccountsBankApi->update_account_with_http_info: #{e}"
|
|
301
|
+
end
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
### Parameters
|
|
305
|
+
|
|
306
|
+
| Name | Type | Description | Notes |
|
|
307
|
+
| ---- | ---- | ----------- | ----- |
|
|
308
|
+
| **account_guid** | **String** | Identifier for the account. | |
|
|
309
|
+
| **patch_account_bank_model** | [**PatchAccountBankModel**](PatchAccountBankModel.md) | | |
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
[**AccountBankModel**](AccountBankModel.md)
|
|
314
|
+
|
|
315
|
+
### Authorization
|
|
316
|
+
|
|
317
|
+
[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
|
|
318
|
+
|
|
319
|
+
### HTTP request headers
|
|
320
|
+
|
|
321
|
+
- **Content-Type**: application/json
|
|
322
|
+
- **Accept**: application/json
|
|
323
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CybridApiBank::PatchAccountBankModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The name of the account. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'cybrid_api_bank_ruby'
|
|
13
|
+
|
|
14
|
+
instance = CybridApiBank::PatchAccountBankModel.new(
|
|
15
|
+
name: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -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 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:execute deposit_bank_accounts:read 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 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_bank_accounts:read 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.
|
|
6
|
+
The version of the OpenAPI document: v0.129.694
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -91,6 +91,7 @@ module CybridApiBank
|
|
|
91
91
|
# Retrieves an account. Required scope: **accounts:read**
|
|
92
92
|
# @param account_guid [String] Identifier for the account.
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
|
+
# @option opts [Boolean] :include_balances Whether to include account balances in the response.
|
|
94
95
|
# @return [AccountBankModel]
|
|
95
96
|
def get_account(account_guid, opts = {})
|
|
96
97
|
data, _status_code, _headers = get_account_with_http_info(account_guid, opts)
|
|
@@ -101,6 +102,7 @@ module CybridApiBank
|
|
|
101
102
|
# Retrieves an account. Required scope: **accounts:read**
|
|
102
103
|
# @param account_guid [String] Identifier for the account.
|
|
103
104
|
# @param [Hash] opts the optional parameters
|
|
105
|
+
# @option opts [Boolean] :include_balances Whether to include account balances in the response.
|
|
104
106
|
# @return [Array<(AccountBankModel, Integer, Hash)>] AccountBankModel data, response status code and response headers
|
|
105
107
|
def get_account_with_http_info(account_guid, opts = {})
|
|
106
108
|
if @api_client.config.debugging
|
|
@@ -115,6 +117,7 @@ module CybridApiBank
|
|
|
115
117
|
|
|
116
118
|
# query parameters
|
|
117
119
|
query_params = opts[:query_params] || {}
|
|
120
|
+
query_params[:'include_balances'] = opts[:'include_balances'] if !opts[:'include_balances'].nil?
|
|
118
121
|
|
|
119
122
|
# header parameters
|
|
120
123
|
header_params = opts[:header_params] || {}
|
|
@@ -161,6 +164,7 @@ module CybridApiBank
|
|
|
161
164
|
# @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.
|
|
162
165
|
# @option opts [String] :customer_guid Comma separated customer_guids to list accounts for.
|
|
163
166
|
# @option opts [String] :label Comma separated labels to list accounts for.
|
|
167
|
+
# @option opts [Boolean] :include_balances Whether to include account balances in the response.
|
|
164
168
|
# @return [AccountListBankModel]
|
|
165
169
|
def list_accounts(opts = {})
|
|
166
170
|
data, _status_code, _headers = list_accounts_with_http_info(opts)
|
|
@@ -178,6 +182,7 @@ module CybridApiBank
|
|
|
178
182
|
# @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.
|
|
179
183
|
# @option opts [String] :customer_guid Comma separated customer_guids to list accounts for.
|
|
180
184
|
# @option opts [String] :label Comma separated labels to list accounts for.
|
|
185
|
+
# @option opts [Boolean] :include_balances Whether to include account balances in the response.
|
|
181
186
|
# @return [Array<(AccountListBankModel, Integer, Hash)>] AccountListBankModel data, response status code and response headers
|
|
182
187
|
def list_accounts_with_http_info(opts = {})
|
|
183
188
|
if @api_client.config.debugging
|
|
@@ -208,6 +213,7 @@ module CybridApiBank
|
|
|
208
213
|
query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
|
|
209
214
|
query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
|
|
210
215
|
query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?
|
|
216
|
+
query_params[:'include_balances'] = opts[:'include_balances'] if !opts[:'include_balances'].nil?
|
|
211
217
|
|
|
212
218
|
# header parameters
|
|
213
219
|
header_params = opts[:header_params] || {}
|
|
@@ -242,5 +248,79 @@ module CybridApiBank
|
|
|
242
248
|
end
|
|
243
249
|
return data, status_code, headers
|
|
244
250
|
end
|
|
251
|
+
|
|
252
|
+
# Patch Account
|
|
253
|
+
# Updates an account. Required scope: **accounts:write**
|
|
254
|
+
# @param account_guid [String] Identifier for the account.
|
|
255
|
+
# @param patch_account_bank_model [PatchAccountBankModel]
|
|
256
|
+
# @param [Hash] opts the optional parameters
|
|
257
|
+
# @return [AccountBankModel]
|
|
258
|
+
def update_account(account_guid, patch_account_bank_model, opts = {})
|
|
259
|
+
data, _status_code, _headers = update_account_with_http_info(account_guid, patch_account_bank_model, opts)
|
|
260
|
+
data
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
# Patch Account
|
|
264
|
+
# Updates an account. Required scope: **accounts:write**
|
|
265
|
+
# @param account_guid [String] Identifier for the account.
|
|
266
|
+
# @param patch_account_bank_model [PatchAccountBankModel]
|
|
267
|
+
# @param [Hash] opts the optional parameters
|
|
268
|
+
# @return [Array<(AccountBankModel, Integer, Hash)>] AccountBankModel data, response status code and response headers
|
|
269
|
+
def update_account_with_http_info(account_guid, patch_account_bank_model, opts = {})
|
|
270
|
+
if @api_client.config.debugging
|
|
271
|
+
@api_client.config.logger.debug 'Calling API: AccountsBankApi.update_account ...'
|
|
272
|
+
end
|
|
273
|
+
# verify the required parameter 'account_guid' is set
|
|
274
|
+
if @api_client.config.client_side_validation && account_guid.nil?
|
|
275
|
+
fail ArgumentError, "Missing the required parameter 'account_guid' when calling AccountsBankApi.update_account"
|
|
276
|
+
end
|
|
277
|
+
# verify the required parameter 'patch_account_bank_model' is set
|
|
278
|
+
if @api_client.config.client_side_validation && patch_account_bank_model.nil?
|
|
279
|
+
fail ArgumentError, "Missing the required parameter 'patch_account_bank_model' when calling AccountsBankApi.update_account"
|
|
280
|
+
end
|
|
281
|
+
# resource path
|
|
282
|
+
local_var_path = '/api/accounts/{account_guid}'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s))
|
|
283
|
+
|
|
284
|
+
# query parameters
|
|
285
|
+
query_params = opts[:query_params] || {}
|
|
286
|
+
|
|
287
|
+
# header parameters
|
|
288
|
+
header_params = opts[:header_params] || {}
|
|
289
|
+
# HTTP header 'Accept' (if needed)
|
|
290
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
291
|
+
# HTTP header 'Content-Type'
|
|
292
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
293
|
+
if !content_type.nil?
|
|
294
|
+
header_params['Content-Type'] = content_type
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
# form parameters
|
|
298
|
+
form_params = opts[:form_params] || {}
|
|
299
|
+
|
|
300
|
+
# http body (model)
|
|
301
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_account_bank_model)
|
|
302
|
+
|
|
303
|
+
# return_type
|
|
304
|
+
return_type = opts[:debug_return_type] || 'AccountBankModel'
|
|
305
|
+
|
|
306
|
+
# auth_names
|
|
307
|
+
auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
|
|
308
|
+
|
|
309
|
+
new_options = opts.merge(
|
|
310
|
+
:operation => :"AccountsBankApi.update_account",
|
|
311
|
+
:header_params => header_params,
|
|
312
|
+
:query_params => query_params,
|
|
313
|
+
:form_params => form_params,
|
|
314
|
+
:body => post_body,
|
|
315
|
+
:auth_names => auth_names,
|
|
316
|
+
:return_type => return_type
|
|
317
|
+
)
|
|
318
|
+
|
|
319
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
320
|
+
if @api_client.config.debugging
|
|
321
|
+
@api_client.config.logger.debug "API called: AccountsBankApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
322
|
+
end
|
|
323
|
+
return data, status_code, headers
|
|
324
|
+
end
|
|
245
325
|
end
|
|
246
326
|
end
|
|
@@ -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 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:execute deposit_bank_accounts:read 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 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_bank_accounts:read 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.
|
|
6
|
+
The version of the OpenAPI document: v0.129.694
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## 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 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:execute deposit_bank_accounts:read 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 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_bank_accounts:read 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.
|
|
6
|
+
The version of the OpenAPI document: v0.129.694
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## 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 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:execute deposit_bank_accounts:read 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 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_bank_accounts:read 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.
|
|
6
|
+
The version of the OpenAPI document: v0.129.694
|
|
7
7
|
Contact: support@cybrid.app
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.0.0
|