app.cybrid.cybrid_api_bank.client.model.BankBankModel Maven / Gradle / Ivy
/*
* Cybrid Bank API
* # Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:[email protected]) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"\", \"client_secret\": \"\", \"scope\": \"\" }' -H \"Content-Type: application/json\" ``` ## 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. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
*
* The version of the OpenAPI document: v0.27.2
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package app.cybrid.cybrid_api_bank.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* BankBankModel
*/
@JsonPropertyOrder({
BankBankModel.JSON_PROPERTY_GUID,
BankBankModel.JSON_PROPERTY_ORGANIZATION_GUID,
BankBankModel.JSON_PROPERTY_NAME,
BankBankModel.JSON_PROPERTY_TYPE,
BankBankModel.JSON_PROPERTY_SUPPORTED_FIAT_ASSETS,
BankBankModel.JSON_PROPERTY_FEATURES,
BankBankModel.JSON_PROPERTY_CREATED_AT
})
@JsonTypeName("Bank")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-06-16T13:21:55.427016Z[Etc/UTC]")
public class BankBankModel {
public static final String JSON_PROPERTY_GUID = "guid";
private String guid;
public static final String JSON_PROPERTY_ORGANIZATION_GUID = "organization_guid";
private String organizationGuid;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
/**
* The bank's type.
*/
public enum TypeEnum {
SANDBOX("sandbox");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type;
public static final String JSON_PROPERTY_SUPPORTED_FIAT_ASSETS = "supported_fiat_assets";
private List supportedFiatAssets = null;
/**
* Gets or Sets features
*/
public enum FeaturesEnum {
ATTESTATION_IDENTITY_RECORDS("attestation_identity_records"),
BACKSTOPPED_FUNDING_SOURCE("backstopped_funding_source");
private String value;
FeaturesEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static FeaturesEnum fromValue(String value) {
for (FeaturesEnum b : FeaturesEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_FEATURES = "features";
private List features = new ArrayList<>();
public static final String JSON_PROPERTY_CREATED_AT = "created_at";
private OffsetDateTime createdAt;
public BankBankModel() {
}
public BankBankModel guid(String guid) {
this.guid = guid;
return this;
}
/**
* Auto-generated unique identifier for the bank.
* @return guid
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "Auto-generated unique identifier for the bank.")
@JsonProperty(JSON_PROPERTY_GUID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getGuid() {
return guid;
}
@JsonProperty(JSON_PROPERTY_GUID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setGuid(String guid) {
this.guid = guid;
}
public BankBankModel organizationGuid(String organizationGuid) {
this.organizationGuid = organizationGuid;
return this;
}
/**
* The organization's identifier.
* @return organizationGuid
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The organization's identifier.")
@JsonProperty(JSON_PROPERTY_ORGANIZATION_GUID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getOrganizationGuid() {
return organizationGuid;
}
@JsonProperty(JSON_PROPERTY_ORGANIZATION_GUID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setOrganizationGuid(String organizationGuid) {
this.organizationGuid = organizationGuid;
}
public BankBankModel name(String name) {
this.name = name;
return this;
}
/**
* The bank's name.
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The bank's name.")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setName(String name) {
this.name = name;
}
public BankBankModel type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The bank's type.
* @return type
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The bank's type.")
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public TypeEnum getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setType(TypeEnum type) {
this.type = type;
}
public BankBankModel supportedFiatAssets(List supportedFiatAssets) {
this.supportedFiatAssets = supportedFiatAssets;
return this;
}
public BankBankModel addSupportedFiatAssetsItem(String supportedFiatAssetsItem) {
if (this.supportedFiatAssets == null) {
this.supportedFiatAssets = new ArrayList<>();
}
this.supportedFiatAssets.add(supportedFiatAssetsItem);
return this;
}
/**
* The bank's list of supported fiat assets.
* @return supportedFiatAssets
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The bank's list of supported fiat assets.")
@JsonProperty(JSON_PROPERTY_SUPPORTED_FIAT_ASSETS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getSupportedFiatAssets() {
return supportedFiatAssets;
}
@JsonProperty(JSON_PROPERTY_SUPPORTED_FIAT_ASSETS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSupportedFiatAssets(List supportedFiatAssets) {
this.supportedFiatAssets = supportedFiatAssets;
}
public BankBankModel features(List features) {
this.features = features;
return this;
}
public BankBankModel addFeaturesItem(FeaturesEnum featuresItem) {
this.features.add(featuresItem);
return this;
}
/**
* The bank's enabled features.
* @return features
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The bank's enabled features.")
@JsonProperty(JSON_PROPERTY_FEATURES)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public List getFeatures() {
return features;
}
@JsonProperty(JSON_PROPERTY_FEATURES)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setFeatures(List features) {
this.features = features;
}
public BankBankModel createdAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* ISO8601 datetime the bank was created at.
* @return createdAt
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "ISO8601 datetime the bank was created at.")
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public OffsetDateTime getCreatedAt() {
return createdAt;
}
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCreatedAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BankBankModel bank = (BankBankModel) o;
return Objects.equals(this.guid, bank.guid) &&
Objects.equals(this.organizationGuid, bank.organizationGuid) &&
Objects.equals(this.name, bank.name) &&
Objects.equals(this.type, bank.type) &&
Objects.equals(this.supportedFiatAssets, bank.supportedFiatAssets) &&
Objects.equals(this.features, bank.features) &&
Objects.equals(this.createdAt, bank.createdAt);
}
@Override
public int hashCode() {
return Objects.hash(guid, organizationGuid, name, type, supportedFiatAssets, features, createdAt);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BankBankModel {\n");
sb.append(" guid: ").append(toIndentedString(guid)).append("\n");
sb.append(" organizationGuid: ").append(toIndentedString(organizationGuid)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" supportedFiatAssets: ").append(toIndentedString(supportedFiatAssets)).append("\n");
sb.append(" features: ").append(toIndentedString(features)).append("\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy