RubyGems - cybrid_api_bank_ruby - Versions diffs - 0.125.49 → 0.125.50 - Mend

cybrid_api_bank_ruby 0.125.49 → 0.125.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (969) hide show

data/cybrid_api_bank_ruby.gemspec CHANGED Viewed

@@ -3,9 +3,9 @@
 =begin
 #Cybrid Bank API
-## 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 Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app)  In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-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://kb.cybrid.xyz/getting-ready-for-trading), 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:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute 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:execute banks:read banks:write banks:execute bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font>  ## Authentication Scopes  The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.  The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource.  | Resource              | Read scope (Token Type)                                    | Write scope (Token Type)                      | Execute scope (Token Type)                       | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account               | accounts:read (Organization, Bank, Customer)               |                                               | accounts:execute (Bank, Customer)                | | Bank                  | banks:read (Organization, Bank)                            | banks:write (Organization, Bank)              | banks:execute (Organization)                     | | Customer              | customers:read (Organization, Bank, Customer)              | customers:write (Bank, Customer)              | customers:execute (Bank)                         | | Counterparty          | counterparties:read (Organization, Bank, Customer)         | counterparties:write (Bank, Customer)         | counterparties:execute (Bank)                    | | Deposit Address       | deposit_addresses:read (Organization, Bank, Customer)      | deposit_addresses:write (Bank, Customer)      | deposit_addresses:execute (Bank, Customer)       | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer)  | | External Wallet       | external_wallet:read (Organization, Bank, Customer)        |                                               | external_wallet:execute (Bank, Customer)         | | Organization          | organizations:read (Organization)                          | organizations:write (Organization)            |                                                  | | User                  | users:read (Organization)                                  |                                               | users:execute (Organization)                     | | Price                 | prices:read (Bank, Customer)                               |                                               |                                                  | | Quote                 | quotes:read (Organization, Bank, Customer)                 |                                               | quotes:execute (Organization, Bank, Customer)    | | Trade                 | trades:read (Organization, Bank, Customer)                 |                                               | trades:execute (Organization, Bank, Customer)    | | Transfer              | transfers:read (Organization, Bank, Customer)              |                                               | transfers:execute (Organization, Bank, Customer) | | Workflow              | workflows:read (Organization, Bank, Customer)              |                                               | workflows:execute (Bank, Customer)               | | Invoice               | invoices:read (Organization, Bank, Customer)               | invoices:write (Bank, Customer)               | invoices:execute (Bank, Customer)                |  ## Available Endpoints  The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below:  | API Service  | Model                | API Endpoint Path              | Description                                                                                       | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity     | Bank                 | /api/bank_applications         | Create and list banks                                                                             | | Identity     | CustomerToken        | /api/customer_tokens           | Create customer JWT access tokens                                                                 | | Identity     | Organization         | /api/organization_applications | Create and list organizations                                                                     | | Identity     | Organization         | /api/users                     | Create and list organization users                                                                | | Organization | Organization         | /api/organizations             | APIs to retrieve and update organization name                                                     | | Bank         | Account              | /api/accounts                  | Create and list accounts, which hold a specific asset for a customers                             | | Bank         | Asset                | /api/assets                    | Get a list of assets supported by the platform (ex: BTC, ETH)                                     | | Bank         | Bank                 | /api/banks                     | Create, update and list banks, the parent to customers, accounts, etc                             | | Bank         | Customer             | /api/customers                 | Create and list customers                                                                         | | Bank         | Counterparty         | /api/counterparties            | Create and list counterparties                                                                    | | Bank         | DepositAddress       | /api/deposit_addresses         | Create, get and list deposit addresses                                                            | | Bank         | ExternalBankAccount  | /api/external_bank_accounts    | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank         | ExternalWallet       | /api/external_wallets          | Create, get, list and delete external wallets, which connect customer wallets to the platform     | | Bank         | IdentityVerification | /api/identity_verifications    | Create and list identity verifications, which are performed on customers for KYC                  | | Bank         | Invoice              | /api/invoices                  | Create, get, cancel and list invoices                                                             | | Bank         | PaymentInstruction   | /api/payment_instructions      | Create, get and list payment instructions for invoices                                            | | Bank         | Price                | /api/prices                    | Get the current prices for assets on the platform                                                 | | Bank         | Quote                | /api/quotes                    | Create and list quotes, which are required to execute trades                                      | | Bank         | Symbol               | /api/symbols                   | Get a list of symbols supported for trade (ex: BTC-USD)                                           | | Bank         | Trade                | /api/trades                    | Create and list trades, which buy or sell cryptocurrency                                          | | Bank         | Transfer             | /api/transfers                 | Create, get and list transfers (e.g., funding, book)                                              | | Bank         | Workflow             | /api/workflows                 | Create, get and list workflows                                                                    |  ## Understanding Object Models & Endpoints  **Organizations**  An `Organization` is meant to represent the organization partnering with Cybrid to use our platform.  An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform.  **Banks**  A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`.  An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.  **Customers**  `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers.  `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified.  `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
+## 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](<api_platform_bank_swagger_schema_url>) 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 Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app)  In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-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://kb.cybrid.xyz/getting-ready-for-trading), 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](<api_platform_organization_swagger_ui_url>)   | APIs to manage organizations                                | | [Bank API](<api_platform_bank_swagger_ui_url>)                   | APIs to manage banks (and all downstream customer activity) | | [Identities API](<api_idp_swagger_ui_url>)                       | 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](<api_idp_url>). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](<api_idp_url>) 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](<api_idp_swagger_ui_url>).  <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 <api_idp_url>/oauth/token -d '{     \"grant_type\": \"client_credentials\",     \"client_id\": \"<Your Client ID>\",     \"client_secret\": \"<Your Secret>\",     \"scope\": \"<api_platform_bank_scopes>\"   }' -H \"Content-Type: application/json\"  # When using Organization credentials set `scope` to '<api_platform_organization_scopes>' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font>  ## Authentication Scopes  The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.  The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource.  | Resource              | Read scope (Token Type)                                    | Write scope (Token Type)                      | Execute scope (Token Type)                       | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account               | accounts:read (Organization, Bank, Customer)               |                                               | accounts:execute (Bank, Customer)                | | Bank                  | banks:read (Organization, Bank)                            | banks:write (Organization, Bank)              | banks:execute (Organization)                     | | Customer              | customers:read (Organization, Bank, Customer)              | customers:write (Bank, Customer)              | customers:execute (Bank)                         | | Counterparty          | counterparties:read (Organization, Bank, Customer)         | counterparties:write (Bank, Customer)         | counterparties:execute (Bank)                    | | Deposit Address       | deposit_addresses:read (Organization, Bank, Customer)      | deposit_addresses:write (Bank, Customer)      | deposit_addresses:execute (Bank, Customer)       | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer)  | | External Wallet       | external_wallet:read (Organization, Bank, Customer)        |                                               | external_wallet:execute (Bank, Customer)         | | Organization          | organizations:read (Organization)                          | organizations:write (Organization)            |                                                  | | User                  | users:read (Organization)                                  |                                               | users:execute (Organization)                     | | Price                 | prices:read (Bank, Customer)                               |                                               |                                                  | | Quote                 | quotes:read (Organization, Bank, Customer)                 |                                               | quotes:execute (Organization, Bank, Customer)    | | Trade                 | trades:read (Organization, Bank, Customer)                 |                                               | trades:execute (Organization, Bank, Customer)    | | Transfer              | transfers:read (Organization, Bank, Customer)              |                                               | transfers:execute (Organization, Bank, Customer) | | Workflow              | workflows:read (Organization, Bank, Customer)              |                                               | workflows:execute (Bank, Customer)               | | Invoice               | invoices:read (Organization, Bank, Customer)               | invoices:write (Bank, Customer)               | invoices:execute (Bank, Customer)                |  ## Available Endpoints  The available APIs for the [Identity](<api_idp_swagger_ui_url>), [Organization](<api_platform_organization_swagger_ui_url>) and [Bank](<api_platform_bank_swagger_ui_url>) API services are listed below:  | API Service  | Model                | API Endpoint Path              | Description                                                                                       | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity     | Bank                 | /api/bank_applications         | Create and list banks                                                                             | | Identity     | CustomerToken        | /api/customer_tokens           | Create customer JWT access tokens                                                                 | | Identity     | Organization         | /api/organization_applications | Create and list organizations                                                                     | | Identity     | Organization         | /api/users                     | Create and list organization users                                                                | | Organization | Organization         | /api/organizations             | APIs to retrieve and update organization name                                                     | | Bank         | Account              | /api/accounts                  | Create and list accounts, which hold a specific asset for a customers                             | | Bank         | Asset                | /api/assets                    | Get a list of assets supported by the platform (ex: BTC, ETH)                                     | | Bank         | Bank                 | /api/banks                     | Create, update and list banks, the parent to customers, accounts, etc                             | | Bank         | Customer             | /api/customers                 | Create and list customers                                                                         | | Bank         | Counterparty         | /api/counterparties            | Create and list counterparties                                                                    | | Bank         | DepositAddress       | /api/deposit_addresses         | Create, get and list deposit addresses                                                            | | Bank         | ExternalBankAccount  | /api/external_bank_accounts    | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank         | ExternalWallet       | /api/external_wallets          | Create, get, list and delete external wallets, which connect customer wallets to the platform     | | Bank         | IdentityVerification | /api/identity_verifications    | Create and list identity verifications, which are performed on customers for KYC                  | | Bank         | Invoice              | /api/invoices                  | Create, get, cancel and list invoices                                                             | | Bank         | PaymentInstruction   | /api/payment_instructions      | Create, get and list payment instructions for invoices                                            | | Bank         | Price                | /api/prices                    | Get the current prices for assets on the platform                                                 | | Bank         | Quote                | /api/quotes                    | Create and list quotes, which are required to execute trades                                      | | Bank         | Symbol               | /api/symbols                   | Get a list of symbols supported for trade (ex: BTC-USD)                                           | | Bank         | Trade                | /api/trades                    | Create and list trades, which buy or sell cryptocurrency                                          | | Bank         | Transfer             | /api/transfers                 | Create, get and list transfers (e.g., funding, book)                                              | | Bank         | Workflow             | /api/workflows                 | Create, get and list workflows                                                                    |  ## Understanding Object Models & Endpoints  **Organizations**  An `Organization` is meant to represent the organization partnering with Cybrid to use our platform.  An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform.  **Banks**  A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`.  An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.  **Customers**  `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers.  `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified.  `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
-The version of the OpenAPI document: v0.125.49
+The version of the OpenAPI document: v0.0.0
 Contact: support@cybrid.app
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0

data/docs/AccountAssociationBankModel.md ADDED Viewed

@@ -0,0 +1,34 @@
+# CybridApiBank::AccountAssociationBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Auto-generated unique identifier for the transfer account. |  |
+| **type** | **String** | The type of transfer account; one of trading or external_bank_account. |  |
+| **bank_guid** | **String** | The account&#39;s bank identifier. | [optional] |
+| **customer_guid** | **String** | The account&#39;s customer identifier. | [optional] |
+| **counterparty_guid** | **String** | The account&#39;s counterparty identifier. | [optional] |
+| **asset** | **String** | The account asset, e.g., USD. |  |
+| **requested_amount** | **Integer** | The requested amount in base units intended to transfer from or to the account. | [optional] |
+| **quoted_amount** | **Integer** | The quoted amount in base units to transfer from or to the account. | [optional] |
+| **executed_amount** | **Integer** | The executed amount in base units transferred from or to the account. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::AccountAssociationBankModel.new(
+  guid: null,
+  type: null,
+  bank_guid: null,
+  customer_guid: null,
+  counterparty_guid: null,
+  asset: null,
+  requested_amount: null,
+  quoted_amount: null,
+  executed_amount: null
+)
+```

data/docs/AccountsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::AccountsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/AssetsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::AssetsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/BanksBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::BanksBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/CounterpartiesBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::CounterpartiesBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/CustomersBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::CustomersBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/DepositAddressesBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::DepositAddressesBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/DepositBankAccountsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::DepositBankAccountsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/ExecutionBankModel.md ADDED Viewed

@@ -0,0 +1,44 @@
+# CybridApiBank::ExecutionBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Auto-generated unique identifier for the quote. |  |
+| **type** | **String** | The type of product the plan is for; one of remittance. |  |
+| **plan_guid** | **String** | The unique identifier for the plan. |  |
+| **bank_guid** | **String** | The unique identifier for the bank. | [optional] |
+| **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
+| **created_at** | **Time** | ISO8601 datetime the record was created at. |  |
+| **updated_at** | **Time** | ISO8601 datetime the record was last updated at. |  |
+| **state** | **String** | The state of the execution; one of storing, executing, completed, or failed. |  |
+| **failure_code** | **String** | The failure code for failed executions. | [optional] |
+| **source_account** | [**AccountAssociationBankModel**](AccountAssociationBankModel.md) |  |  |
+| **destination_account** | [**AccountAssociationBankModel**](AccountAssociationBankModel.md) |  |  |
+| **stages** | [**Array&lt;StageBankModel&gt;**](StageBankModel.md) | The stages of the execution. |  |
+| **fees** | [**Array&lt;FeeAssociationBankModel&gt;**](FeeAssociationBankModel.md) | The fees associated with the execution. |  |
+| **travel_rule_info** | [**ExecutionTravelRuleInfoBankModel**](ExecutionTravelRuleInfoBankModel.md) |  |  |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::ExecutionBankModel.new(
+  guid: null,
+  type: null,
+  plan_guid: null,
+  bank_guid: null,
+  customer_guid: null,
+  created_at: null,
+  updated_at: null,
+  state: null,
+  failure_code: null,
+  source_account: null,
+  destination_account: null,
+  stages: null,
+  fees: null,
+  travel_rule_info: null
+)
+```

data/docs/ExecutionTravelRuleInfoBankModel.md ADDED Viewed

@@ -0,0 +1,24 @@
+# CybridApiBank::ExecutionTravelRuleInfoBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **originating_party** | [**TravelRuleInfoPartyBankModel**](TravelRuleInfoPartyBankModel.md) |  |  |
+| **receiving_party** | [**TravelRuleInfoPartyBankModel**](TravelRuleInfoPartyBankModel.md) |  |  |
+| **ultimate_originating_party** | [**TravelRuleInfoPartyBankModel**](TravelRuleInfoPartyBankModel.md) |  | [optional] |
+| **ultimate_receiving_party** | [**TravelRuleInfoPartyBankModel**](TravelRuleInfoPartyBankModel.md) |  | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::ExecutionTravelRuleInfoBankModel.new(
+  originating_party: null,
+  receiving_party: null,
+  ultimate_originating_party: null,
+  ultimate_receiving_party: null
+)
+```

data/docs/ExecutionsBankApi.md ADDED Viewed

@@ -0,0 +1,153 @@
+# CybridApiBank::ExecutionsBankApi
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_execution**](ExecutionsBankApi.md#create_execution) | **POST** /api/executions | Create Execution |
+| [**get_execution**](ExecutionsBankApi.md#get_execution) | **GET** /api/executions/{execution_guid} | Get Execution |
+## create_execution
+> <ExecutionBankModel> create_execution(post_execution_bank_model)
+Create Execution
+Creates an execution.  post  Required scope: **executions:execute**
+### Examples
+```ruby
+require 'time'
+require 'cybrid_api_bank_ruby'
+# setup authorization
+CybridApiBank.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+api_instance = CybridApiBank::ExecutionsBankApi.new
+post_execution_bank_model = CybridApiBank::PostExecutionBankModel.new({plan_guid: 'plan_guid_example'}) # PostExecutionBankModel |
+begin
+  # Create Execution
+  result = api_instance.create_execution(post_execution_bank_model)
+  p result
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling ExecutionsBankApi->create_execution: #{e}"
+end
+```
+#### Using the create_execution_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<ExecutionBankModel>, Integer, Hash)> create_execution_with_http_info(post_execution_bank_model)
+```ruby
+begin
+  # Create Execution
+  data, status_code, headers = api_instance.create_execution_with_http_info(post_execution_bank_model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExecutionBankModel>
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling ExecutionsBankApi->create_execution_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_execution_bank_model** | [**PostExecutionBankModel**](PostExecutionBankModel.md) |  |  |
+### Return type
+[**ExecutionBankModel**](ExecutionBankModel.md)
+### Authorization
+[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json
+## get_execution
+> <ExecutionBankModel> get_execution(execution_guid)
+Get Execution
+Retrieves a execution.  Required scope: **executions:read**
+### Examples
+```ruby
+require 'time'
+require 'cybrid_api_bank_ruby'
+# setup authorization
+CybridApiBank.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+api_instance = CybridApiBank::ExecutionsBankApi.new
+execution_guid = 'execution_guid_example' # String | Identifier for the payment instruction.
+begin
+  # Get Execution
+  result = api_instance.get_execution(execution_guid)
+  p result
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling ExecutionsBankApi->get_execution: #{e}"
+end
+```
+#### Using the get_execution_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<ExecutionBankModel>, Integer, Hash)> get_execution_with_http_info(execution_guid)
+```ruby
+begin
+  # Get Execution
+  data, status_code, headers = api_instance.get_execution_with_http_info(execution_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExecutionBankModel>
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling ExecutionsBankApi->get_execution_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **execution_guid** | **String** | Identifier for the payment instruction. |  |
+### Return type
+[**ExecutionBankModel**](ExecutionBankModel.md)
+### Authorization
+[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json

data/docs/ExternalBankAccountsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::ExternalBankAccountsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/ExternalWalletsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::ExternalWalletsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/FeeAssociationBankModel.md ADDED Viewed

@@ -0,0 +1,24 @@
+# CybridApiBank::FeeAssociationBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of fee; one of platform, network, or bank. |  |
+| **asset** | **String** | The asset the fee is denominated in, e.g., USD. |  |
+| **quoted_amount** | **Integer** | The quoted amount in base units for the fee. |  |
+| **executed_amount** | **Integer** | The executed amount in base units for the fee. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::FeeAssociationBankModel.new(
+  type: null,
+  asset: null,
+  quoted_amount: null,
+  executed_amount: null
+)
+```

data/docs/FilesBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::FilesBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/IdentityVerificationsBankApi.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CybridApiBank::IdentityVerificationsBankApi
-All URIs are relative to *https://bank.sandbox.cybrid.app*
+All URIs are relative to *http://api-platform-bank.local.cybrid.com:3002*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/InternalActivityLimitBankModel.md ADDED Viewed

@@ -0,0 +1,26 @@
+# CybridApiBank::InternalActivityLimitBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the limit. |  |
+| **limit_type** | **String** | The type of the limit. |  |
+| **limit_asset** | **String** | The asset of the limit. |  |
+| **limit_amount** | **Integer** | The amount of the limit. |  |
+| **limit_interval** | **Integer** | The interval of the limit. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalActivityLimitBankModel.new(
+  name: null,
+  limit_type: null,
+  limit_asset: null,
+  limit_amount: null,
+  limit_interval: null
+)
+```

data/docs/InternalActivityLimitConfigurationBankModel.md ADDED Viewed

@@ -0,0 +1,40 @@
+# CybridApiBank::InternalActivityLimitConfigurationBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Auto-generated unique identifier for the configuration. | [optional] |
+| **type** | **String** | The type of configuration; one of platform, bank, or customer. | [optional] |
+| **activity** | **String** | The (optional) activity the configuration is associated with; one of trading, funding, book_transfer, or crypto_transfer. | [optional] |
+| **side** | **String** | The (optional) side the configuration is associated with; one of deposit or withdrawal. | [optional] |
+| **environment** | **String** | The environment the configuration is associated with. | [optional] |
+| **bank_guid** | **String** | The bank identifier that the configuration is associated with. | [optional] |
+| **customer_guid** | **String** | The customer identifier that the configuration is associated with. | [optional] |
+| **audience** | **String** | The payment rail. | [optional] |
+| **country_code** | **String** | The ISO 3166 country 2-Alpha country code the configuration. | [optional] |
+| **limits** | [**Array&lt;InternalActivityLimitBankModel&gt;**](InternalActivityLimitBankModel.md) | The limits for the configuration. | [optional] |
+| **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
+| **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalActivityLimitConfigurationBankModel.new(
+  guid: null,
+  type: null,
+  activity: null,
+  side: null,
+  environment: null,
+  bank_guid: null,
+  customer_guid: null,
+  audience: null,
+  country_code: null,
+  limits: null,
+  created_at: null,
+  updated_at: null
+)
+```

data/docs/InternalActivityLimitConfigurationListBankModel.md ADDED Viewed

@@ -0,0 +1,24 @@
+# CybridApiBank::InternalActivityLimitConfigurationListBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | The total number of records available. |  |
+| **page** | **Integer** | The page index to retrieve. |  |
+| **per_page** | **Integer** | The number of entities per page to return. |  |
+| **objects** | [**Array&lt;InternalActivityLimitConfigurationBankModel&gt;**](InternalActivityLimitConfigurationBankModel.md) | Array of entities |  |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalActivityLimitConfigurationListBankModel.new(
+  total: null,
+  page: null,
+  per_page: null,
+  objects: null
+)
+```

data/docs/InternalActivityReportBankModel.md ADDED Viewed

@@ -0,0 +1,28 @@
+# CybridApiBank::InternalActivityReportBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The activity report&#39;s type | [optional] |
+| **customer_guid** | **String** | The identifier of the customer for the report. | [optional] |
+| **asset** | **String** | The asset code to report on. | [optional] |
+| **start_time** | **Time** | Inclusive ISO8601 datetime start time of the period to report on. | [optional] |
+| **end_time** | **Time** | Inclusive ISO8601 datetime end time of the period to report on. | [optional] |
+| **items** | [**Array&lt;InternalActivityReportItemBankModel&gt;**](InternalActivityReportItemBankModel.md) | The items in the report. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalActivityReportBankModel.new(
+  type: null,
+  customer_guid: null,
+  asset: null,
+  start_time: null,
+  end_time: null,
+  items: null
+)
+```

data/docs/InternalActivityReportItemBankModel.md ADDED Viewed

@@ -0,0 +1,24 @@
+# CybridApiBank::InternalActivityReportItemBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The item&#39;s type | [optional] |
+| **asset** | **String** | The asset code. | [optional] |
+| **pending_amount** | **Integer** | The pending amount in base units of the asset | [optional] |
+| **completed_amount** | **Integer** | The completed amount in base units of the asset | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalActivityReportItemBankModel.new(
+  type: null,
+  asset: null,
+  pending_amount: null,
+  completed_amount: null
+)
+```

data/docs/InternalBankAccountServiceBankModel.md ADDED Viewed

@@ -0,0 +1,30 @@
+# CybridApiBank::InternalBankAccountServiceBankModel
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Auto-generated unique identifier for the bank account service. | [optional] |
+| **type** | **String** | The service type. | [optional] |
+| **name** | **String** | The name of the service. | [optional] |
+| **environment** | **String** | The environment that the service is operating in. | [optional] |
+| **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
+| **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
+| **state** | **String** | The state of the service. | [optional] |
+## Example
+```ruby
+require 'cybrid_api_bank_ruby'
+instance = CybridApiBank::InternalBankAccountServiceBankModel.new(
+  guid: null,
+  type: null,
+  name: null,
+  environment: null,
+  created_at: null,
+  updated_at: null,
+  state: null
+)
+```