Swift5 API client for CybridApiBankSwift

Cybrid API documentation

Welcome to Cybrid, an all-in-one crypto platform that enables you to easily build and launch white-lable 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.

💡 We recommend bookmarking the Cybrid LinkTree 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 API's.

Note: If you'd like to use a different tool to exercise our API's, you can download the Open API 3.0 yaml for import.

If you're new to our API's and the Cybrid Platform, follow the below guides to get set up and familiar with the platform:

1. Getting Started in the Cybrid Sandbox
2. Getting Ready for Trading
3. Running the Web Demo App

In Getting Started in the Cybrid Sandbox, we walk you through how to use the Cybrid Sandbox to create a test bank, generate API keys, and set banks fees. In Getting Ready for Trading, we walk through creating customers, customer identities, accounts, as well as executing quotes and trades.

If you've already run through the first two guides, you can follow the Running the Web Demo App guide to test our web SDK with your sandbox bank and customer.

Working with the Cybrid Platform

There are three primary ways you can interact with the Cybrid platform:

1. Directly via our RESTful API (this documentation)
2. Using our API Clients available in a variety of languages (Angular, Java, Kotlin, Python, Ruby, Swift or Typescript)
3. Integrating a platform specific SDK (Web, Android, Apple)

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 API's reside.

The complete set of APIs can be found on the following pages:

For questions please contact Support at any time for assistance, or contact the Product Team 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.

An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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.

<font color="orange">⚠️ Never share your Client ID or Secret publicly or in your source code repository.

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.

curl -X POST <api_idp_url>/oauth/token -d '{
    \"grant_type\": \"client_credentials\",
    \"client_id\": \"<Your Client ID>\",
    \"client_secret\": \"<Your Secret>\",
    \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\"
  }' -H \"Content-Type: application/json\"

<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.

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 or a Bank 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.

Available Endpoints

The available API's for the Identity, Organization and Bank API services are listed below:

Understanding Object Models & Endpoints

Organizations

An Organization is meant to represent the organization partnering with Cybrid to use our platform.

An Organization 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 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid Identity Record. See the Identity Records 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.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: v0.0.0
• Package version:
• Build package: org.openapitools.codegen.languages.Swift5ClientCodegen

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

All URIs are relative to http://api-bank.cybrid.local

Documentation For Models

• AccountBankModel
• AccountListBankModel
• AssetBankModel
• AssetListBankModel
• AttestationDetailsBankModel
• BankBankModel
• BankListBankModel
• CustomerBankModel
• CustomerListBankModel
• ErrorResponseBankModel
• FeeBankModel
• FeeConfigurationBankModel
• FeeConfigurationListBankModel
• IdentityRecordBankModel
• IdentityRecordListBankModel
• InternalCreateExchangeSettlementApproval202ResponseBankModel
• InternalCybridAccountBankModel
• InternalExchangeAccountBankModel
• InternalExchangeBankModel
• InternalExchangeListBankModel
• InternalExchangeSettlementBankModel
• InternalExchangeSettlementObligationBankModel
• InternalExchangeSettlementPaymentOrderBankModel
• InternalExpectedPaymentBankModel
• InternalExternalBankAccountBankModel
• InternalExternalBankAccountListBankModel
• InternalExternalWalletBankModel
• InternalExternalWalletListBankModel
• InternalInternalBankAccountBankModel
• InternalInternalBankAccountListBankModel
• InternalInternalWalletBankModel
• InternalInternalWalletListBankModel
• InternalSystemAccountBankModel
• InternalTradingSymbolConfigurationBankModel
• InternalTransactionBankModel
• PatchBankBankModel
• PatchInternalAccountBankModel
• PostAccountBankModel
• PostBankBankModel
• PostCustomerBankModel
• PostFeeBankModel
• PostFeeConfigurationBankModel
• PostIdentityRecordAttestationDetailsBankModel
• PostIdentityRecordBankModel
• PostInternalAccountBankModel
• PostInternalClaimExchangeSettlementPaymentOrderBankModel
• PostInternalClaimExpectedPaymentBankModel
• PostInternalCybridAccountBankModel
• PostInternalExchangeAccountBankModel
• PostInternalExchangeBankModel
• PostInternalExchangeSettlementBankModel
• PostInternalExchangeSettlementPaymentOrderBankModel
• PostInternalExpectedPaymentBankModel
• PostInternalExternalBankAccountBankModel
• PostInternalExternalWalletBankModel
• PostInternalInternalBankAccountBankModel
• PostInternalInternalWalletBankModel
• PostInternalSystemAccountBankModel
• PostInternalSystemTransactionBankModel
• PostInternalTradingSymbolConfigurationBankModel
• PostQuoteBankModel
• PostRewardBankModel
• PostTradeBankModel
• PostVerificationKeyBankModel
• QuoteBankModel
• QuoteListBankModel
• RewardBankModel
• SymbolPriceBankModel
• TradeBankModel
• TradeListBankModel
• VerificationKeyBankModel
• VerificationKeyListBankModel

Documentation For Authorization

BearerAuth

• Type: HTTP basic authentication

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• banks:read: banks read
• banks:write: banks write
• accounts:read: accounts read
• accounts:execute: accounts execute
• customers:read: customers read
• customers:write: customers write
• customers:execute: customers execute
• prices:read: prices read
• quotes:execute: quotes execute
• quotes:read: quotes read
• trades:execute: trades execute
• trades:read: trades read
• rewards:execute: rewards execute
• rewards:read: rewards read

Author

support@cybrid.app