cybrid_api_bank_ruby 0.129.1239 → 0.129.1241
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 -12
- data/cybrid_api_bank_ruby.gemspec +2 -2
- data/docs/AccountsBankApi.md +1 -1
- data/docs/InvoicesBankApi.md +0 -146
- data/docs/PaymentInstructionsBankApi.md +0 -73
- data/docs/PostQuoteBankModel.md +3 -5
- data/docs/PostTransferBankModel.md +4 -8
- data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +4 -4
- data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +2 -133
- data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +2 -70
- data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/transactions_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
- data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
- data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/balance_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/effective_rate_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/intermediate_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_deposit_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_deposit_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_external_wallet_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/payout_return_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/plan_reference_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/plan_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +4 -4
- data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_plan_intermediate_accounts_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +24 -50
- data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +9 -61
- data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/return_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transaction_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transaction_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transaction_list_page_info_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transaction_resource_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
- data/lib/cybrid_api_bank_ruby/version.rb +3 -3
- data/lib/cybrid_api_bank_ruby.rb +2 -4
- data/spec/api/accounts_bank_api_spec.rb +3 -3
- data/spec/api/assets_bank_api_spec.rb +2 -2
- data/spec/api/banks_bank_api_spec.rb +2 -2
- data/spec/api/counterparties_bank_api_spec.rb +2 -2
- data/spec/api/customers_bank_api_spec.rb +2 -2
- data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
- data/spec/api/deposit_bank_accounts_bank_api_spec.rb +2 -2
- data/spec/api/executions_bank_api_spec.rb +2 -2
- data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
- data/spec/api/external_wallets_bank_api_spec.rb +2 -2
- data/spec/api/files_bank_api_spec.rb +2 -2
- data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
- data/spec/api/invoices_bank_api_spec.rb +2 -26
- data/spec/api/payment_instructions_bank_api_spec.rb +2 -14
- data/spec/api/persona_sessions_bank_api_spec.rb +2 -2
- data/spec/api/plans_bank_api_spec.rb +2 -2
- data/spec/api/prices_bank_api_spec.rb +2 -2
- data/spec/api/quotes_bank_api_spec.rb +2 -2
- data/spec/api/sardine_sessions_bank_api_spec.rb +2 -2
- data/spec/api/symbols_bank_api_spec.rb +2 -2
- data/spec/api/trades_bank_api_spec.rb +2 -2
- data/spec/api/transactions_bank_api_spec.rb +2 -2
- data/spec/api/transfers_bank_api_spec.rb +2 -2
- data/spec/api/workflows_bank_api_spec.rb +2 -2
- data/spec/models/account_association_bank_model_spec.rb +2 -2
- data/spec/models/account_bank_model_spec.rb +2 -2
- data/spec/models/account_list_bank_model_spec.rb +2 -2
- data/spec/models/account_state_bank_model_spec.rb +2 -2
- data/spec/models/account_type_bank_model_spec.rb +2 -2
- data/spec/models/activity_limit_bank_model_spec.rb +2 -2
- data/spec/models/activity_side_bank_model_spec.rb +2 -2
- data/spec/models/activity_type_bank_model_spec.rb +2 -2
- data/spec/models/asset_bank_model_spec.rb +2 -2
- data/spec/models/asset_list_bank_model_spec.rb +2 -2
- data/spec/models/asset_types_bank_model_spec.rb +2 -2
- data/spec/models/balance_bank_model_spec.rb +2 -2
- data/spec/models/bank_bank_model_spec.rb +2 -2
- data/spec/models/bank_feature_bank_model_spec.rb +2 -2
- data/spec/models/bank_list_bank_model_spec.rb +2 -2
- data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +2 -2
- data/spec/models/bank_type_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_outcome_bank_model_spec.rb +2 -2
- data/spec/models/compliance_check_type_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_state_bank_model_spec.rb +2 -2
- data/spec/models/compliance_decision_type_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_list_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_state_bank_model_spec.rb +2 -2
- data/spec/models/counterparty_type_bank_model_spec.rb +2 -2
- data/spec/models/customer_address_bank_model_spec.rb +2 -2
- data/spec/models/customer_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/customer_bank_model_spec.rb +2 -2
- data/spec/models/customer_list_bank_model_spec.rb +2 -2
- data/spec/models/customer_name_bank_model_spec.rb +2 -2
- data/spec/models/customer_state_bank_model_spec.rb +2 -2
- data/spec/models/customer_type_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_format_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
- data/spec/models/deposit_address_state_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_list_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +2 -2
- data/spec/models/deposit_bank_account_state_bank_model_spec.rb +2 -2
- data/spec/models/effective_rate_bank_model_spec.rb +2 -2
- data/spec/models/error_response_bank_model_spec.rb +2 -2
- data/spec/models/execution_bank_model_spec.rb +2 -2
- data/spec/models/execution_list_bank_model_spec.rb +2 -2
- data/spec/models/execution_travel_rule_info_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_balances_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_kind_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +2 -2
- data/spec/models/external_bank_account_state_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_environment_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
- data/spec/models/external_wallet_state_bank_model_spec.rb +2 -2
- data/spec/models/fee_association_bank_model_spec.rb +2 -2
- data/spec/models/fee_detail_bank_model_spec.rb +2 -2
- data/spec/models/hold_detail_bank_model_spec.rb +2 -2
- data/spec/models/identification_number_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_business_associate_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_document_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_document_file_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_method_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_options_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_outcome_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_persona_state_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_state_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_type_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +2 -2
- data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +2 -2
- data/spec/models/intermediate_account_bank_model_spec.rb +2 -2
- data/spec/models/invoice_bank_model_spec.rb +2 -2
- data/spec/models/invoice_list_bank_model_spec.rb +2 -2
- data/spec/models/legal_entity_name_bank_model_spec.rb +2 -2
- data/spec/models/patch_account_bank_model_spec.rb +2 -2
- data/spec/models/patch_bank_bank_model_spec.rb +2 -2
- data/spec/models/patch_customer_bank_model_spec.rb +2 -2
- data/spec/models/patch_deposit_address_bank_model_spec.rb +2 -2
- data/spec/models/patch_deposit_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/patch_external_wallet_bank_model_spec.rb +2 -2
- data/spec/models/patch_transfer_bank_model_spec.rb +2 -2
- data/spec/models/patch_transfer_participant_bank_model_spec.rb +2 -2
- data/spec/models/payment_instruction_bank_model_spec.rb +2 -2
- data/spec/models/payment_instruction_list_bank_model_spec.rb +2 -2
- data/spec/models/payout_return_details_bank_model_spec.rb +2 -2
- data/spec/models/persona_session_bank_model_spec.rb +2 -2
- data/spec/models/physical_address_bank_model_spec.rb +2 -2
- data/spec/models/plan_bank_model_spec.rb +2 -2
- data/spec/models/plan_list_bank_model_spec.rb +2 -2
- data/spec/models/plan_reference_bank_model_spec.rb +2 -2
- data/spec/models/plan_travel_rule_info_bank_model_spec.rb +2 -2
- data/spec/models/plan_type_bank_model_spec.rb +2 -2
- data/spec/models/platform_file_bank_model_spec.rb +2 -2
- data/spec/models/platform_file_list_bank_model_spec.rb +2 -2
- data/spec/models/post_account_bank_model_spec.rb +3 -3
- data/spec/models/post_bank_account_details_bank_model_spec.rb +2 -2
- data/spec/models/post_bank_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_bank_model_spec.rb +2 -2
- data/spec/models/post_counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_bank_model_spec.rb +2 -2
- data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
- data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
- data/spec/models/post_deposit_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/post_execution_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +2 -2
- data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +2 -2
- data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
- data/spec/models/post_fee_bank_model_spec.rb +2 -2
- data/spec/models/post_file_bank_model_spec.rb +2 -2
- data/spec/models/post_file_metadata_bank_model_spec.rb +2 -2
- data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
- data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +2 -2
- data/spec/models/post_persona_session_bank_model_spec.rb +2 -2
- data/spec/models/post_plan_bank_model_spec.rb +2 -2
- data/spec/models/post_plan_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/post_plan_intermediate_accounts_inner_bank_model_spec.rb +2 -2
- data/spec/models/post_plan_source_account_bank_model_spec.rb +2 -2
- data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +2 -2
- data/spec/models/post_quote_bank_model_spec.rb +8 -14
- data/spec/models/post_quote_entry_bank_model_spec.rb +2 -2
- data/spec/models/post_sardine_session_bank_model_spec.rb +2 -2
- data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +2 -2
- data/spec/models/post_supporting_document_bank_model_spec.rb +2 -2
- data/spec/models/post_trade_bank_model_spec.rb +2 -2
- data/spec/models/post_transfer_bank_model_spec.rb +3 -15
- data/spec/models/post_transfer_participant_bank_model_spec.rb +2 -2
- data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +2 -2
- data/spec/models/post_workflow_bank_model_spec.rb +2 -2
- data/spec/models/quote_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/quote_entry_source_account_bank_model_spec.rb +2 -2
- data/spec/models/quote_list_bank_model_spec.rb +2 -2
- data/spec/models/quote_side_bank_model_spec.rb +2 -2
- data/spec/models/quote_type_bank_model_spec.rb +2 -2
- data/spec/models/return_details_bank_model_spec.rb +2 -2
- data/spec/models/sardine_session_bank_model_spec.rb +2 -2
- data/spec/models/stage_bank_model_spec.rb +2 -2
- data/spec/models/stage_identifier_bank_model_spec.rb +2 -2
- data/spec/models/stage_link_bank_model_spec.rb +2 -2
- data/spec/models/supporting_document_bank_model_spec.rb +2 -2
- data/spec/models/supporting_document_file_bank_model_spec.rb +2 -2
- data/spec/models/symbol_price_bank_model_spec.rb +2 -2
- data/spec/models/trade_bank_model_spec.rb +2 -2
- data/spec/models/trade_failure_code_bank_model_spec.rb +2 -2
- data/spec/models/trade_list_bank_model_spec.rb +2 -2
- data/spec/models/trade_side_bank_model_spec.rb +2 -2
- data/spec/models/trade_state_bank_model_spec.rb +2 -2
- data/spec/models/trade_type_bank_model_spec.rb +2 -2
- data/spec/models/transaction_bank_model_spec.rb +2 -2
- data/spec/models/transaction_list_bank_model_spec.rb +2 -2
- data/spec/models/transaction_list_page_info_bank_model_spec.rb +2 -2
- data/spec/models/transaction_resource_bank_model_spec.rb +2 -2
- data/spec/models/transfer_account_type_bank_model_spec.rb +2 -2
- data/spec/models/transfer_bank_model_spec.rb +2 -2
- data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_entry_bank_model_spec.rb +2 -2
- data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_failure_code_bank_model_spec.rb +2 -2
- data/spec/models/transfer_hold_details_bank_model_spec.rb +2 -2
- data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +2 -2
- data/spec/models/transfer_list_bank_model_spec.rb +2 -2
- data/spec/models/transfer_participant_bank_model_spec.rb +2 -2
- data/spec/models/transfer_side_bank_model_spec.rb +2 -2
- data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
- data/spec/models/transfer_state_bank_model_spec.rb +2 -2
- data/spec/models/transfer_type_bank_model_spec.rb +2 -2
- data/spec/models/travel_rule_info_party_bank_model_spec.rb +2 -2
- data/spec/models/workflow_bank_model_spec.rb +2 -2
- data/spec/models/workflow_state_bank_model_spec.rb +2 -2
- data/spec/models/workflow_type_bank_model_spec.rb +2 -2
- data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
- data/spec/models/workflows_list_bank_model_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- 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.9.4/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.5.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 +1 -9
- data/docs/PostInvoiceBankModel.md +0 -28
- data/docs/PostPaymentInstructionBankModel.md +0 -20
- data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +0 -369
- data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +0 -287
- data/spec/models/post_invoice_bank_model_spec.rb +0 -66
- data/spec/models/post_payment_instruction_bank_model_spec.rb +0 -46
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fbe90bd232ab766489a366418f640e01051dcc972e3afe9ee344363ede2ce8ca
|
|
4
|
+
data.tar.gz: 7c4267296ae1a84fcf50b436abe83133479511bca8bc343e662157faaf73cd65
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ba7116c0f0e922b33f9d91dd692b22e59804d26c92d54be755f20c8d2faab8e8fbb2002954ebe67af2ae2142cb54514b72aa4d5b0f41f2da2be2b65dd969d8ad
|
|
7
|
+
data.tar.gz: 9652a9c9e95a2666621af3278cb22fd966e73043c9c997eaf513dce0a44588f00bc1d9c6a2ed5856506ae8f03969ae9be1fdc79ed372e843ebfd7b3245f54296
|
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.1241)
|
|
5
5
|
httpx (~> 1.0, >= 1.0.0)
|
|
6
6
|
logger
|
|
7
7
|
|
|
@@ -80,7 +80,7 @@ CHECKSUMS
|
|
|
80
80
|
ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
|
|
81
81
|
byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
|
|
82
82
|
coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
|
|
83
|
-
cybrid_api_bank_ruby (0.129.
|
|
83
|
+
cybrid_api_bank_ruby (0.129.1241)
|
|
84
84
|
date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
|
|
85
85
|
diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
|
|
86
86
|
http-2 (1.2.3) sha256=f4e3a7000e9a8ab97595f09eac44c6ec10a2aa438360758124df0ca5bcb280d4
|
data/README.md
CHANGED
|
@@ -121,8 +121,8 @@ The available APIs for the [Identity](https://id.production.cybrid.app/api/schem
|
|
|
121
121
|
| Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform |
|
|
122
122
|
| Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform |
|
|
123
123
|
| Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC |
|
|
124
|
-
| Bank | Invoice | /api/invoices |
|
|
125
|
-
| Bank | PaymentInstruction | /api/payment_instructions |
|
|
124
|
+
| Bank | Invoice | /api/invoices | Get and list invoices |
|
|
125
|
+
| Bank | PaymentInstruction | /api/payment_instructions | Get and list payment instructions for invoices |
|
|
126
126
|
| Bank | Price | /api/prices | Get the current prices for assets on the platform |
|
|
127
127
|
| Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades |
|
|
128
128
|
| Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) |
|
|
@@ -155,8 +155,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
|
|
|
155
155
|
|
|
156
156
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
157
157
|
|
|
158
|
-
- API version: v0.129.
|
|
159
|
-
- Package version: 0.129.
|
|
158
|
+
- API version: v0.129.1241
|
|
159
|
+
- Package version: 0.129.1241
|
|
160
160
|
- Generator version: 7.8.0
|
|
161
161
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
162
162
|
|
|
@@ -173,16 +173,16 @@ gem build cybrid_api_bank_ruby.gemspec
|
|
|
173
173
|
Then either install the gem locally:
|
|
174
174
|
|
|
175
175
|
```shell
|
|
176
|
-
gem install ./cybrid_api_bank_ruby-0.129.
|
|
176
|
+
gem install ./cybrid_api_bank_ruby-0.129.1241.gem
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.
|
|
179
|
+
(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.129.1241.gem` to install the development dependencies)
|
|
180
180
|
|
|
181
181
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
182
182
|
|
|
183
183
|
Finally add this to the Gemfile:
|
|
184
184
|
|
|
185
|
-
gem 'cybrid_api_bank_ruby', '~> 0.129.
|
|
185
|
+
gem 'cybrid_api_bank_ruby', '~> 0.129.1241'
|
|
186
186
|
|
|
187
187
|
### Install from Git
|
|
188
188
|
|
|
@@ -286,11 +286,8 @@ Class | Method | HTTP request | Description
|
|
|
286
286
|
*CybridApiBank::IdentityVerificationsBankApi* | [**create_identity_verification**](docs/IdentityVerificationsBankApi.md#create_identity_verification) | **POST** /api/identity_verifications | Create Identity Verification
|
|
287
287
|
*CybridApiBank::IdentityVerificationsBankApi* | [**get_identity_verification**](docs/IdentityVerificationsBankApi.md#get_identity_verification) | **GET** /api/identity_verifications/{identity_verification_guid} | Get Identity Verification
|
|
288
288
|
*CybridApiBank::IdentityVerificationsBankApi* | [**list_identity_verifications**](docs/IdentityVerificationsBankApi.md#list_identity_verifications) | **GET** /api/identity_verifications | List Identity Verifications
|
|
289
|
-
*CybridApiBank::InvoicesBankApi* | [**cancel_invoice**](docs/InvoicesBankApi.md#cancel_invoice) | **DELETE** /api/invoices/{invoice_guid} | Cancel Invoice
|
|
290
|
-
*CybridApiBank::InvoicesBankApi* | [**create_invoice**](docs/InvoicesBankApi.md#create_invoice) | **POST** /api/invoices | Create Invoice
|
|
291
289
|
*CybridApiBank::InvoicesBankApi* | [**get_invoice**](docs/InvoicesBankApi.md#get_invoice) | **GET** /api/invoices/{invoice_guid} | Get Invoice
|
|
292
290
|
*CybridApiBank::InvoicesBankApi* | [**list_invoices**](docs/InvoicesBankApi.md#list_invoices) | **GET** /api/invoices | List Invoices
|
|
293
|
-
*CybridApiBank::PaymentInstructionsBankApi* | [**create_payment_instruction**](docs/PaymentInstructionsBankApi.md#create_payment_instruction) | **POST** /api/payment_instructions | Create Payment Instruction
|
|
294
291
|
*CybridApiBank::PaymentInstructionsBankApi* | [**get_payment_instruction**](docs/PaymentInstructionsBankApi.md#get_payment_instruction) | **GET** /api/payment_instructions/{payment_instruction_guid} | Get Payment Instruction
|
|
295
292
|
*CybridApiBank::PaymentInstructionsBankApi* | [**list_payment_instructions**](docs/PaymentInstructionsBankApi.md#list_payment_instructions) | **GET** /api/payment_instructions | List Payment Instructions
|
|
296
293
|
*CybridApiBank::PersonaSessionsBankApi* | [**create_persona_session**](docs/PersonaSessionsBankApi.md#create_persona_session) | **POST** /api/persona_sessions | Create Persona Session
|
|
@@ -458,8 +455,6 @@ Class | Method | HTTP request | Description
|
|
|
458
455
|
- [CybridApiBank::PostIdentityVerificationBankModel](docs/PostIdentityVerificationBankModel.md)
|
|
459
456
|
- [CybridApiBank::PostIdentityVerificationNameBankModel](docs/PostIdentityVerificationNameBankModel.md)
|
|
460
457
|
- [CybridApiBank::PostIdentityVerificationRegisteredAddressBankModel](docs/PostIdentityVerificationRegisteredAddressBankModel.md)
|
|
461
|
-
- [CybridApiBank::PostInvoiceBankModel](docs/PostInvoiceBankModel.md)
|
|
462
|
-
- [CybridApiBank::PostPaymentInstructionBankModel](docs/PostPaymentInstructionBankModel.md)
|
|
463
458
|
- [CybridApiBank::PostPersonaSessionBankModel](docs/PostPersonaSessionBankModel.md)
|
|
464
459
|
- [CybridApiBank::PostPlanBankModel](docs/PostPlanBankModel.md)
|
|
465
460
|
- [CybridApiBank::PostPlanDestinationAccountBankModel](docs/PostPlanDestinationAccountBankModel.md)
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#Cybrid Bank API
|
|
5
5
|
|
|
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 accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Bank Application | bank_applications:read (Organization, Bank) | | | | 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 Application | organization_applications:read (Organization) | | | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (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) | API keys and organization users are created, updated and deleted only in the Partner Portal. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write` or `users:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest. ## 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 | Get and list bank API keys | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Get and list organization API keys | | Identity | Organization | /api/users | Get 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.
|
|
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 accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Bank Application | bank_applications:read (Organization, Bank) | | | | 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 Application | organization_applications:read (Organization) | | | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (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) | API keys and organization users are created, updated and deleted only in the Partner Portal. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write` or `users:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest. ## 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 | Get and list bank API keys | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Get and list organization API keys | | Identity | Organization | /api/users | Get 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 | Get and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | 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.1241
|
|
9
9
|
Contact: support@cybrid.app
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
Generator version: 7.8.0
|
data/docs/AccountsBankApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *https://bank.sandbox.cybrid.app*
|
|
|
16
16
|
|
|
17
17
|
Create Account
|
|
18
18
|
|
|
19
|
-
Creates an account. ## Account Type An Account is tied to a specific cryptocurrency or fiat and is comprised of transactions and a current balance. An account is required to allow a Bank or Customer to hold cryptocurrency or a Customer to hold fiat on the Cybrid Platform. At present, accounts can be created as `trading`, `storage` or `fiat ` accounts and are required before a Customer can generate quotes or execute a `trade` or `transfer`. To create accounts for your Bank, omit the `customer_guid` parameter in the request body. To create accounts for your Customers, include the `customer_guid` parameter in the request body.
|
|
19
|
+
Creates an account. ## Account Type An Account is tied to a specific cryptocurrency or fiat and is comprised of transactions and a current balance. An account is required to allow a Bank or Customer to hold cryptocurrency or a Customer to hold fiat on the Cybrid Platform. At present, accounts can be created as `trading`, `storage` or `fiat ` accounts and are required before a Customer can generate quotes or execute a `trade` or `transfer`. To create accounts for your Bank, omit the `customer_guid` parameter in the request body. To create accounts for your Customers, include the `customer_guid` parameter in the request body. ## Asset The asset is the specific cryptocurrency or fiat that the account holds, e.g., 'BTC' for Bitcoin or `USD` for US dollars. See the Symbols API for a complete list of cryptocurrencies and fiat supported. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the account details in our private store | | created | The Platform has created the account | Required scope: **accounts:execute**
|
|
20
20
|
|
|
21
21
|
### Examples
|
|
22
22
|
|
data/docs/InvoicesBankApi.md
CHANGED
|
@@ -4,156 +4,10 @@ All URIs are relative to *https://bank.sandbox.cybrid.app*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**cancel_invoice**](InvoicesBankApi.md#cancel_invoice) | **DELETE** /api/invoices/{invoice_guid} | Cancel Invoice |
|
|
8
|
-
| [**create_invoice**](InvoicesBankApi.md#create_invoice) | **POST** /api/invoices | Create Invoice |
|
|
9
7
|
| [**get_invoice**](InvoicesBankApi.md#get_invoice) | **GET** /api/invoices/{invoice_guid} | Get Invoice |
|
|
10
8
|
| [**list_invoices**](InvoicesBankApi.md#list_invoices) | **GET** /api/invoices | List Invoices |
|
|
11
9
|
|
|
12
10
|
|
|
13
|
-
## cancel_invoice
|
|
14
|
-
|
|
15
|
-
> <InvoiceBankModel> cancel_invoice(invoice_guid)
|
|
16
|
-
|
|
17
|
-
Cancel Invoice
|
|
18
|
-
|
|
19
|
-
Cancels an invoice. Required scope: **invoices:execute**
|
|
20
|
-
|
|
21
|
-
### Examples
|
|
22
|
-
|
|
23
|
-
```ruby
|
|
24
|
-
require 'time'
|
|
25
|
-
require 'cybrid_api_bank_ruby'
|
|
26
|
-
# setup authorization
|
|
27
|
-
CybridApiBank.configure do |config|
|
|
28
|
-
# Configure OAuth2 access token for authorization: oauth2
|
|
29
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
30
|
-
|
|
31
|
-
# Configure Bearer authorization (JWT): BearerAuth
|
|
32
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
33
|
-
end
|
|
34
|
-
|
|
35
|
-
api_instance = CybridApiBank::InvoicesBankApi.new
|
|
36
|
-
invoice_guid = 'invoice_guid_example' # String | Identifier for the invoice.
|
|
37
|
-
|
|
38
|
-
begin
|
|
39
|
-
# Cancel Invoice
|
|
40
|
-
result = api_instance.cancel_invoice(invoice_guid)
|
|
41
|
-
p result
|
|
42
|
-
rescue CybridApiBank::ApiError => e
|
|
43
|
-
puts "Error when calling InvoicesBankApi->cancel_invoice: #{e}"
|
|
44
|
-
end
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
#### Using the cancel_invoice_with_http_info variant
|
|
48
|
-
|
|
49
|
-
This returns an Array which contains the response data, status code and headers.
|
|
50
|
-
|
|
51
|
-
> <Array(<InvoiceBankModel>, Integer, Hash)> cancel_invoice_with_http_info(invoice_guid)
|
|
52
|
-
|
|
53
|
-
```ruby
|
|
54
|
-
begin
|
|
55
|
-
# Cancel Invoice
|
|
56
|
-
data, status_code, headers = api_instance.cancel_invoice_with_http_info(invoice_guid)
|
|
57
|
-
p status_code # => 2xx
|
|
58
|
-
p headers # => { ... }
|
|
59
|
-
p data # => <InvoiceBankModel>
|
|
60
|
-
rescue CybridApiBank::ApiError => e
|
|
61
|
-
puts "Error when calling InvoicesBankApi->cancel_invoice_with_http_info: #{e}"
|
|
62
|
-
end
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
| Name | Type | Description | Notes |
|
|
68
|
-
| ---- | ---- | ----------- | ----- |
|
|
69
|
-
| **invoice_guid** | **String** | Identifier for the invoice. | |
|
|
70
|
-
|
|
71
|
-
### Return type
|
|
72
|
-
|
|
73
|
-
[**InvoiceBankModel**](InvoiceBankModel.md)
|
|
74
|
-
|
|
75
|
-
### Authorization
|
|
76
|
-
|
|
77
|
-
[oauth2](../README.md#oauth2), [BearerAuth](../README.md#BearerAuth)
|
|
78
|
-
|
|
79
|
-
### HTTP request headers
|
|
80
|
-
|
|
81
|
-
- **Content-Type**: Not defined
|
|
82
|
-
- **Accept**: application/json
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
## create_invoice
|
|
86
|
-
|
|
87
|
-
> <InvoiceBankModel> create_invoice(post_invoice_bank_model)
|
|
88
|
-
|
|
89
|
-
Create Invoice
|
|
90
|
-
|
|
91
|
-
Creates a invoice. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the invoice details in our private store | | unpaid | The invoice is unpaid. Payment instructions can be generated for an invoice in this state | | cancelling | The invocie is in the process of being cancelled | | cancelled | The invoice has been cancelled | | settling | The invoice has been paid and the funds associated with this invoice are in the process of being settled | | paid | The invoice has been paid and the funds associated with this invoice have been settled | Required scope: **invoices:execute**
|
|
92
|
-
|
|
93
|
-
### Examples
|
|
94
|
-
|
|
95
|
-
```ruby
|
|
96
|
-
require 'time'
|
|
97
|
-
require 'cybrid_api_bank_ruby'
|
|
98
|
-
# setup authorization
|
|
99
|
-
CybridApiBank.configure do |config|
|
|
100
|
-
# Configure OAuth2 access token for authorization: oauth2
|
|
101
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
102
|
-
|
|
103
|
-
# Configure Bearer authorization (JWT): BearerAuth
|
|
104
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
105
|
-
end
|
|
106
|
-
|
|
107
|
-
api_instance = CybridApiBank::InvoicesBankApi.new
|
|
108
|
-
post_invoice_bank_model = CybridApiBank::PostInvoiceBankModel.new({asset: 'asset_example'}) # PostInvoiceBankModel |
|
|
109
|
-
|
|
110
|
-
begin
|
|
111
|
-
# Create Invoice
|
|
112
|
-
result = api_instance.create_invoice(post_invoice_bank_model)
|
|
113
|
-
p result
|
|
114
|
-
rescue CybridApiBank::ApiError => e
|
|
115
|
-
puts "Error when calling InvoicesBankApi->create_invoice: #{e}"
|
|
116
|
-
end
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
#### Using the create_invoice_with_http_info variant
|
|
120
|
-
|
|
121
|
-
This returns an Array which contains the response data, status code and headers.
|
|
122
|
-
|
|
123
|
-
> <Array(<InvoiceBankModel>, Integer, Hash)> create_invoice_with_http_info(post_invoice_bank_model)
|
|
124
|
-
|
|
125
|
-
```ruby
|
|
126
|
-
begin
|
|
127
|
-
# Create Invoice
|
|
128
|
-
data, status_code, headers = api_instance.create_invoice_with_http_info(post_invoice_bank_model)
|
|
129
|
-
p status_code # => 2xx
|
|
130
|
-
p headers # => { ... }
|
|
131
|
-
p data # => <InvoiceBankModel>
|
|
132
|
-
rescue CybridApiBank::ApiError => e
|
|
133
|
-
puts "Error when calling InvoicesBankApi->create_invoice_with_http_info: #{e}"
|
|
134
|
-
end
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### Parameters
|
|
138
|
-
|
|
139
|
-
| Name | Type | Description | Notes |
|
|
140
|
-
| ---- | ---- | ----------- | ----- |
|
|
141
|
-
| **post_invoice_bank_model** | [**PostInvoiceBankModel**](PostInvoiceBankModel.md) | | |
|
|
142
|
-
|
|
143
|
-
### Return type
|
|
144
|
-
|
|
145
|
-
[**InvoiceBankModel**](InvoiceBankModel.md)
|
|
146
|
-
|
|
147
|
-
### Authorization
|
|
148
|
-
|
|
149
|
-
[oauth2](../README.md#oauth2), [BearerAuth](../README.md#BearerAuth)
|
|
150
|
-
|
|
151
|
-
### HTTP request headers
|
|
152
|
-
|
|
153
|
-
- **Content-Type**: application/json
|
|
154
|
-
- **Accept**: application/json
|
|
155
|
-
|
|
156
|
-
|
|
157
11
|
## get_invoice
|
|
158
12
|
|
|
159
13
|
> <InvoiceBankModel> get_invoice(invoice_guid)
|
|
@@ -4,83 +4,10 @@ All URIs are relative to *https://bank.sandbox.cybrid.app*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_payment_instruction**](PaymentInstructionsBankApi.md#create_payment_instruction) | **POST** /api/payment_instructions | Create Payment Instruction |
|
|
8
7
|
| [**get_payment_instruction**](PaymentInstructionsBankApi.md#get_payment_instruction) | **GET** /api/payment_instructions/{payment_instruction_guid} | Get Payment Instruction |
|
|
9
8
|
| [**list_payment_instructions**](PaymentInstructionsBankApi.md#list_payment_instructions) | **GET** /api/payment_instructions | List Payment Instructions |
|
|
10
9
|
|
|
11
10
|
|
|
12
|
-
## create_payment_instruction
|
|
13
|
-
|
|
14
|
-
> <PaymentInstructionBankModel> create_payment_instruction(post_payment_instruction_bank_model)
|
|
15
|
-
|
|
16
|
-
Create Payment Instruction
|
|
17
|
-
|
|
18
|
-
Creates a payment instruction. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the payment instruction details in our private store | | created | The Platform has created the payment instruction | | expired | The PaymentInstruction is no longer valid | Required scope: **invoices:write**
|
|
19
|
-
|
|
20
|
-
### Examples
|
|
21
|
-
|
|
22
|
-
```ruby
|
|
23
|
-
require 'time'
|
|
24
|
-
require 'cybrid_api_bank_ruby'
|
|
25
|
-
# setup authorization
|
|
26
|
-
CybridApiBank.configure do |config|
|
|
27
|
-
# Configure OAuth2 access token for authorization: oauth2
|
|
28
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
29
|
-
|
|
30
|
-
# Configure Bearer authorization (JWT): BearerAuth
|
|
31
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
api_instance = CybridApiBank::PaymentInstructionsBankApi.new
|
|
35
|
-
post_payment_instruction_bank_model = CybridApiBank::PostPaymentInstructionBankModel.new({invoice_guid: 'invoice_guid_example'}) # PostPaymentInstructionBankModel |
|
|
36
|
-
|
|
37
|
-
begin
|
|
38
|
-
# Create Payment Instruction
|
|
39
|
-
result = api_instance.create_payment_instruction(post_payment_instruction_bank_model)
|
|
40
|
-
p result
|
|
41
|
-
rescue CybridApiBank::ApiError => e
|
|
42
|
-
puts "Error when calling PaymentInstructionsBankApi->create_payment_instruction: #{e}"
|
|
43
|
-
end
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
#### Using the create_payment_instruction_with_http_info variant
|
|
47
|
-
|
|
48
|
-
This returns an Array which contains the response data, status code and headers.
|
|
49
|
-
|
|
50
|
-
> <Array(<PaymentInstructionBankModel>, Integer, Hash)> create_payment_instruction_with_http_info(post_payment_instruction_bank_model)
|
|
51
|
-
|
|
52
|
-
```ruby
|
|
53
|
-
begin
|
|
54
|
-
# Create Payment Instruction
|
|
55
|
-
data, status_code, headers = api_instance.create_payment_instruction_with_http_info(post_payment_instruction_bank_model)
|
|
56
|
-
p status_code # => 2xx
|
|
57
|
-
p headers # => { ... }
|
|
58
|
-
p data # => <PaymentInstructionBankModel>
|
|
59
|
-
rescue CybridApiBank::ApiError => e
|
|
60
|
-
puts "Error when calling PaymentInstructionsBankApi->create_payment_instruction_with_http_info: #{e}"
|
|
61
|
-
end
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Parameters
|
|
65
|
-
|
|
66
|
-
| Name | Type | Description | Notes |
|
|
67
|
-
| ---- | ---- | ----------- | ----- |
|
|
68
|
-
| **post_payment_instruction_bank_model** | [**PostPaymentInstructionBankModel**](PostPaymentInstructionBankModel.md) | | |
|
|
69
|
-
|
|
70
|
-
### Return type
|
|
71
|
-
|
|
72
|
-
[**PaymentInstructionBankModel**](PaymentInstructionBankModel.md)
|
|
73
|
-
|
|
74
|
-
### Authorization
|
|
75
|
-
|
|
76
|
-
[oauth2](../README.md#oauth2), [BearerAuth](../README.md#BearerAuth)
|
|
77
|
-
|
|
78
|
-
### HTTP request headers
|
|
79
|
-
|
|
80
|
-
- **Content-Type**: application/json
|
|
81
|
-
- **Accept**: application/json
|
|
82
|
-
|
|
83
|
-
|
|
84
11
|
## get_payment_instruction
|
|
85
12
|
|
|
86
13
|
> <PaymentInstructionBankModel> get_payment_instruction(payment_instruction_guid)
|
data/docs/PostQuoteBankModel.md
CHANGED
|
@@ -9,10 +9,9 @@
|
|
|
9
9
|
| **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
|
|
10
10
|
| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell for trade quotes. | [optional] |
|
|
11
11
|
| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell for trade quotes. | [optional] |
|
|
12
|
-
| **asset** | **String** | The asset code the quote was requested for. Required when product_type is
|
|
13
|
-
| **network_address** | **String** | The network address to pay the invoice to. Required when product_type is lightning_transfer. | [optional] |
|
|
14
|
-
| **fees** | [**Array<PostFeeBankModel>**](PostFeeBankModel.md) | The custom fees associated with the quote Optional when product_type is lightning_transfer, product_type is funding, product_type is trading, product_type is crypto_transfer, or product_type is trading_exit. | [optional] |
|
|
12
|
+
| **asset** | **String** | The asset code the quote was requested for. Required when product_type is book_transfer, product_type is funding, product_type is crypto_transfer, or product_type is inter_account. | [optional] |
|
|
15
13
|
| **side** | **String** | The direction for trade quotes: either 'buy' or 'sell'. The direction for funding quotes: either 'deposit' or 'withdrawal'. The direction for crypto transfer quotes: 'withdrawal'. Book transfers do not require a side. They are all 'deposit's. Required when product_type is funding, product_type is trading, or product_type is crypto_transfer. | [optional] |
|
|
14
|
+
| **fees** | [**Array<PostFeeBankModel>**](PostFeeBankModel.md) | The custom fees associated with the quote Optional when product_type is funding, product_type is trading, product_type is crypto_transfer, or product_type is trading_exit. | [optional] |
|
|
16
15
|
| **destination_account_guid** | **String** | The unique identifier for the destination account. Used to determine routing-specific fees for EFT withdrawals. Required when product_type is inter_account. Optional when product_type is funding. | [optional] |
|
|
17
16
|
| **payment_rail** | **String** | The payment rail the resulting transfer will execute on. Required when the downstream transfer will be an e-transfer withdrawal. Optional when product_type is funding. | [optional] |
|
|
18
17
|
| **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. Required when product_type is trading. | [optional] |
|
|
@@ -32,9 +31,8 @@ instance = CybridApiBank::PostQuoteBankModel.new(
|
|
|
32
31
|
receive_amount: null,
|
|
33
32
|
deliver_amount: null,
|
|
34
33
|
asset: null,
|
|
35
|
-
network_address: null,
|
|
36
|
-
fees: null,
|
|
37
34
|
side: null,
|
|
35
|
+
fees: null,
|
|
38
36
|
destination_account_guid: null,
|
|
39
37
|
payment_rail: null,
|
|
40
38
|
symbol: null,
|
|
@@ -13,16 +13,14 @@
|
|
|
13
13
|
| **beneficiary_memo** | **String** | The memo to send to the counterparty. Optional when transfer_type is funding. | [optional] |
|
|
14
14
|
| **security_question** | **String** | The security question to send with an Interac E-Transfer withdrawal. Only accepted for e-transfer rail withdrawals; must be paired with security_answer. Optional when transfer_type is funding. | [optional] |
|
|
15
15
|
| **security_answer** | **String** | The security answer the recipient must provide to claim an Interac E-Transfer. Only accepted for e-transfer rail withdrawals; must be paired with security_question. Optional when transfer_type is funding. | [optional] |
|
|
16
|
-
| **source_participants** | [**Array<PostTransferParticipantBankModel>**](PostTransferParticipantBankModel.md) | The source participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book,
|
|
17
|
-
| **destination_participants** | [**Array<PostTransferParticipantBankModel>**](PostTransferParticipantBankModel.md) | The destination participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book,
|
|
16
|
+
| **source_participants** | [**Array<PostTransferParticipantBankModel>**](PostTransferParticipantBankModel.md) | The source participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, or transfer_type is crypto. | [optional] |
|
|
17
|
+
| **destination_participants** | [**Array<PostTransferParticipantBankModel>**](PostTransferParticipantBankModel.md) | The destination participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, or transfer_type is crypto. | [optional] |
|
|
18
18
|
| **sardine_session_guid** | **String** | The GUID of a previously created Sardine session. Used to correlate device signals from the Sardine SDK with the transfer screening. Optional when transfer_type is funding or transfer_type is instant_funding. | [optional] |
|
|
19
|
-
| **bank_fiat_account_guid** | **String** | The identifier for the fiat account to use for the transfer. Required if the bank has multiple fiat accounts. Optional when transfer_type is instant_funding
|
|
20
|
-
| **customer_fiat_account_guid** | **String** | The identifier for the fiat account to use for the transfer. Required if the customer has multiple fiat accounts. Optional when transfer_type is instant_funding
|
|
19
|
+
| **bank_fiat_account_guid** | **String** | The identifier for the fiat account to use for the transfer. Required if the bank has multiple fiat accounts. Optional when transfer_type is instant_funding. | [optional] |
|
|
20
|
+
| **customer_fiat_account_guid** | **String** | The identifier for the fiat account to use for the transfer. Required if the customer has multiple fiat accounts. Optional when transfer_type is instant_funding. | [optional] |
|
|
21
21
|
| **source_account_guid** | **String** | The source account's identifier. Required when transfer_type is book or transfer_type is inter_account. | [optional] |
|
|
22
22
|
| **destination_account_guid** | **String** | The destination account's identifier. Required when transfer_type is book or transfer_type is inter_account. | [optional] |
|
|
23
23
|
| **external_wallet_guid** | **String** | The customer's external wallet's identifier. Optional when transfer_type is crypto. | [optional] |
|
|
24
|
-
| **customer_guid** | **String** | The customer's identifier. Required when transfer_type is lightning. | [optional] |
|
|
25
|
-
| **network_fee_account_guid** | **String** | The network fee account's identifier. Required for network fee transfers. Must be the identifier for the customer's or bank's fiat or trading account. For customer's to pay the network fees, include the customer's fiat or trading account guid. For bank's to pay the network fees, include the bank's fiat or trading account guid. Required when transfer_type is lightning. | [optional] |
|
|
26
24
|
| **expected_behaviours** | **Array<String>** | The optional expected behaviour to simulate. Only applicable for transfers under sandbox banks. The force_review behaviour will force the transfer to be reviewed for funding and instant_funding transfers. | [optional] |
|
|
27
25
|
| **labels** | **Array<String>** | The labels associated with the transfer. | [optional] |
|
|
28
26
|
|
|
@@ -49,8 +47,6 @@ instance = CybridApiBank::PostTransferBankModel.new(
|
|
|
49
47
|
source_account_guid: null,
|
|
50
48
|
destination_account_guid: null,
|
|
51
49
|
external_wallet_guid: null,
|
|
52
|
-
customer_guid: null,
|
|
53
|
-
network_fee_account_guid: null,
|
|
54
50
|
expected_behaviours: null,
|
|
55
51
|
labels: null
|
|
56
52
|
)
|